Interface StepPrecedence

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
All Known Subinterfaces:
ConditionalPrecedence

public interface StepPrecedence extends SecondaryType
The preceding and succeeding steps in a process.

Attributes of StepPrecedence are:

Associations of StepPrecedence are:

Usage

To create an instance of this StepPrecedence, use the factory create methods.
Example: create a StepPrecedence with name "StepPrecedence_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();
 StepPrecedence myObject = (StepPrecedence) factory.createComplexMetadataObject(objectStore, "StepPrecedence_Object", MetadataObjects.STEPPRECEDENCE, "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

    • ASSOCIATION_PREDECESSORS_NAME

      static final String ASSOCIATION_PREDECESSORS_NAME
      Constant used for the name of the Predecessors association.

      Predecessors: The predecessor TransformationStep. 

      See Also:
    • ASSOCIATION_SUCCESSORS_NAME

      static final String ASSOCIATION_SUCCESSORS_NAME
      Constant used for the name of the Successors association.

      Successors: The successor TransformationStep. 

      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
      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
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
    • getPredecessors

      AssociationList getPredecessors() throws RemoteException, MdException
      Gets the Association list of Predecessors
      Returns:
      The AssociationList of Predecessors which can be of type:
      TransformationStep
      SyncStep
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • getSuccessors

      AssociationList getSuccessors() throws RemoteException, MdException
      Gets the Association list of Successors
      Returns:
      The AssociationList of Successors which can be of type:
      TransformationStep
      SyncStep
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • getPredecessors

      AssociationList getPredecessors(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Predecessors
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Predecessors which can be of type:
      TransformationStep
      SyncStep
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • getSuccessors

      AssociationList getSuccessors(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Successors
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Successors which can be of type:
      TransformationStep
      SyncStep
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • setPredecessors

      void setPredecessors(AssociationList list) throws RemoteException
      Sets the Predecessors list to be list. Objects of which can be of type:
      TransformationStep
      SyncStep
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.
    • setPredecessors

      void setPredecessors(AssociationList inObjects, int state) throws RemoteException
      Sets the entire Predecessors list to match the passed in AssociationList, sets the state of the Predecessors
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.
    • setSuccessors

      void setSuccessors(AssociationList list) throws RemoteException
      Sets the Successors list to be list. Objects of which can be of type:
      TransformationStep
      SyncStep
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.
    • setSuccessors

      void setSuccessors(AssociationList inObjects, int state) throws RemoteException
      Sets the entire Successors list to match the passed in AssociationList, sets the state of the Successors
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.