Package mks.ci.server

Class DeleteAllTimeEntryOp

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, mks.ci.server.BulkOp, mks.ci.server.ITriggerExposedOp, mks.frame.server.audit.IAuditable
    public class DeleteAllTimeEntryOp
extends mks.ci.server.BaseTimeEntryOp
    A bulk operation for deleting a batch of time entries
    Since:
    Bentley
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface mks.ci.server.BulkOp

        COMMIT_ON_SUCCESS_AND_ROLLBACK_FAIL, CONTINUE_ON_ERROR, FIRE_TRIGGER_EVENTS, PER_OP_RESULTS, REPORT_PROGRESS, ROLLBACK_ON_ERROR

    • Constructor Summary

      Constructors 
      Constructor Description
      DeleteAllTimeEntryOp()
      Default constructor, should only be used for serialization.
      DeleteAllTimeEntryOp​(mks.ci.common.DeleteAllTEInfo info)
      Construct an operation to delete a batch of time entries

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void checkPermission​(int requestingUserID, int clientVersion)
      Test permissions to determine if this operation can be performed.
      java.lang.String getDisplayString()  
      LocalTriggerManager.ScriptOperationBean getScriptBean​(int userId, java.sql.Connection connection)
      Get the bean that wraps this op in trigger scripts.
      mks.frame.triggers.TriggerEvent getTriggerEvent()
      Get the trigger event the operation participates in.
      mks.ci.server.BulkOpResult performOp​(mks.ci.server.CacheUpdate cacheUpdate, int currentUserID)
      Perform the operation.
      void readExternal​(java.io.ObjectInput in)  
      void writeExternal​(java.io.ObjectOutput out)  

      • Methods inherited from class mks.ci.server.BaseTimeEntryOp

        getInfo, getObjectType

      • Methods inherited from class mks.ci.server.BaseBulkOp

        checkClientVersion, getAuditCategory, getConnection, getContext, getContextType, getOpDisplayString, getTarget, getTargetType, init, isMultiStageOp, performSecondStage

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DeleteAllTimeEntryOp

        public DeleteAllTimeEntryOp()
        Default constructor, should only be used for serialization.

      • DeleteAllTimeEntryOp

        public DeleteAllTimeEntryOp​(mks.ci.common.DeleteAllTEInfo info)
        Construct an operation to delete a batch of time entries
        Parameters:
        info -

    • Method Detail

      • getDisplayString

        public java.lang.String getDisplayString()
        Specified by:
        getDisplayString in interface mks.ci.server.BulkOp
        Specified by:
        getDisplayString in class mks.ci.server.BaseBulkOp
        Returns:
        The display string for the object that is being operated on.
        See Also:
        BulkOp.getDisplayString()

      • checkPermission

        public void checkPermission​(int requestingUserID,
                            int clientVersion)
                     throws mks.ci.exception.CIException
        Description copied from class: mks.ci.server.BaseBulkOp
        Test permissions to determine if this operation can be performed.
        Specified by:
        checkPermission in interface mks.ci.server.BulkOp
        Overrides:
        checkPermission in class mks.ci.server.BaseBulkOp
        Parameters:
        requestingUserID - - the ID of the user performing the operation
        clientVersion - the version of the client protocol. This method also checks if this client protocol is legal.
        Throws:
        mks.ci.exception.PermissionDeniedException - if the user doesn't have permissions.
        mks.ci.exception.CIException
        See Also:
        BulkOp.checkPermission(int, int)

      • performOp

        public mks.ci.server.BulkOpResult performOp​(mks.ci.server.CacheUpdate cacheUpdate,
                                            int currentUserID)
                                     throws mks.ci.exception.CIException
        Description copied from interface: mks.ci.server.BulkOp
        Perform the operation.
        Parameters:
        cacheUpdate - The container which accumulates cache update information, processed after the transaction is committed.
        currentUserID - The ID of the user performing the operation.
        Returns:
        The BulkOpResult specific to the operation.
        Throws:
        mks.ci.exception.CIException
        See Also:
        BulkOp.performOp(mks.ci.server.CacheUpdate, int)

      • getTriggerEvent

        public mks.frame.triggers.TriggerEvent getTriggerEvent()
        Description copied from interface: mks.ci.server.ITriggerExposedOp
        Get the trigger event the operation participates in.
        Returns:
        The trigger event of the operation.
        See Also:
        ITriggerExposedOp.getTriggerEvent()

      • getScriptBean

        public LocalTriggerManager.ScriptOperationBean getScriptBean​(int userId,
                                                             java.sql.Connection connection)
        Description copied from interface: mks.ci.server.ITriggerExposedOp
        Get the bean that wraps this op in trigger scripts.
        Parameters:
        userId - the current user
        connection - our database connection
        Returns:
        The bean that wraps the operation.
        See Also:
        ITriggerExposedOp.getScriptBean(int, Connection)

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                   throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Overrides:
        writeExternal in class mks.ci.server.BaseTimeEntryOp
        Throws:
        java.io.IOException
        See Also:
        Externalizable.writeExternal(ObjectOutput)

      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Overrides:
        readExternal in class mks.ci.server.BaseTimeEntryOp
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
        See Also:
        Externalizable.readExternal(ObjectInput)