com.ibm.jarm.api.core

Interface Hold

    • Method Detail

      • getHoldName

        java.lang.String getHoldName()
        Returns the HoldName property value.
        Returns:
        A String value. This entry can be null.
      • setHoldName

        void setHoldName(java.lang.String holdName)
        Sets the HoldName property value.

        This name value must be unique relative to all other holds defined on the same file plan repository. Validation of such name uniqueness does not occur until the save is called.

        Parameters:
        holdName - a String value. This entry cannot be null.
      • getConditionXML

        java.lang.String getConditionXML()
        Returns the ConditionXML property value.

        Returns:
        A String value. This entry can be null.
      • setConditionXML

        void setConditionXML(java.lang.String conditionXML)
        Sets the value for the ConditionXML property value.
        Parameters:
        conditionXML - a String value. This entry can be null or blank.
      • getSweepState

        java.lang.Integer getSweepState()
        Returns the SweepState property value.
        Returns:
        A Integer value. This entry can be null.
      • setSweepState

        void setSweepState(java.lang.Integer sweepState)
        Sets the value for the SweepState property value.
        Parameters:
        sweepState - a Integer value. This entry can be null.
      • getHoldReason

        java.lang.String getHoldReason()
        Returns the HoldReason property value.
        Returns:
        A String value. This entry can be null.
      • setHoldReason

        void setHoldReason(java.lang.String reason)
        Sets the value for the HoldReason property value.
        Parameters:
        reason - a String value. This entry can be null or blank.
      • isActive

        java.lang.Boolean isActive()
        Returns a Boolean value indicating whether the hold is active.
        Returns:
        true if the hold is active, false otherwise.
      • setActiveState

        void setActiveState(boolean isActive)
        Set the active state for this hold instance.
        Parameters:
        isActive - true to activate the hold, false to deactivate the hold.
      • getHoldType

        java.lang.String getHoldType()
        Returns the HoldType property value.
        Returns:
        A String value indicating the type of hold.
      • setHoldType

        void setHoldType(java.lang.String holdType)
        Sets the value for the HoldType property value.
        Parameters:
        holdType - a String value that can be null or can be the value of one of the "HoldTypeList" choice list.
      • getAssociatedRecords

        PageableSet<Record> getAssociatedRecords(java.lang.Integer pageSize)
        Returns a collection of Record instances that are associated with this hold.
        Parameters:
        pageSize - an optional Integer page size value. If null then the repository default value is used.
        Returns:
        A PageableSet of Record instances.
      • getAssociatedContainers

        PageableSet<Container> getAssociatedContainers(java.lang.Integer pageSize)
        Returns a collection of Container instances that are associated with this hold.
        Parameters:
        pageSize - an optional Integer page size value. If null then the repository default value is used.
        Returns:
        A PageableSet of Container instances.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.