Package com.sas.metadata.remote

Interface ConditionalPrecedence

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType, StepPrecedence
public interface ConditionalPrecedence extends StepPrecedence
The preceding and succeeding steps based on the stated condition.

Attributes of ConditionalPrecedence are:

Associations of ConditionalPrecedence are:

Usage

To create an instance of this ConditionalPrecedence, use the factory create methods.
Example: create a ConditionalPrecedence with name "ConditionalPrecedence_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 ConditionalPrecedence myObject = (ConditionalPrecedence) factory.createComplexMetadataObject(objectStore, "ConditionalPrecedence_Object", MetadataObjects.CONDITIONALPRECEDENCE, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_CONDITION_NAME

      static final String ATTRIBUTE_CONDITION_NAME
      Constant used for the name of the Condition attribute.

      Condition: The condition that must be met in order to continue with the succeeding steps. The format of the condition is left up to the application.

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      Specified by:
      initializeRequiredObjects in interface StepPrecedence
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Specified by:
      initializePredObjects in interface StepPrecedence
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCondition

      String getCondition() throws RemoteException
      Gets the String value of Condition
      Returns:
      The Condition
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getConditionState

      int getConditionState() throws RemoteException
      Gets the Metadata State of Condition
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getConditionMaxLength

      int getConditionMaxLength() throws RemoteException
      Gets the maximum length of Condition
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • setCondition

      void setCondition(String inCondition) throws RemoteException
      Sets the Condition value and sets the state to MetadataState.LOCAL.
      Parameters:
      inCondition - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setCondition

      void setCondition(String inCondition, int state) throws RemoteException
      Sets the Condition Metadata State.
      Parameters:
      inCondition - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setConditionState

      void setConditionState(int state) throws RemoteException
      Sets the Metadata State of Condition.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.