Package com.sas.metadata.remote

Interface Event

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Event extends PrimaryType
Describes a condition that occurs that drives other actions, ie. jobs, to be processed.

Attributes of Event are:

Associations of Event are:

Usage

To create an instance of this Event, use the factory create methods.
Example: create a Event with name "Event_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();
 Event myObject = (Event) factory.createComplexMetadataObject(objectStore, "Event_Object", MetadataObjects.EVENT, "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: Indicates what condition the triggering transformation must meet to be considered (success, failure, warnings, etc.)

      See Also:

    • ATTRIBUTE_EVENTROLE_NAME

      static final String ATTRIBUTE_EVENTROLE_NAME
      Constant used for the name of the EventRole attribute.

      EventRole: Internal or External

      See Also:

    • ASSOCIATION_EVENTBROKERS_NAME

      static final String ASSOCIATION_EVENTBROKERS_NAME
      Constant used for the name of the EventBrokers association.

      EventBrokers: The event brokers for this set of events.  

      See Also:

    • ASSOCIATION_TRIGGEREDTRANSFORMS_NAME

      static final String ASSOCIATION_TRIGGEREDTRANSFORMS_NAME
      Constant used for the name of the TriggeredTransforms association.

      TriggeredTransforms: The transforms that are triggered by this event.  

      See Also:

    • ASSOCIATION_TRIGGERINGTRANSFORMS_NAME

      static final String ASSOCIATION_TRIGGERINGTRANSFORMS_NAME
      Constant used for the name of the TriggeringTransforms association.

      TriggeringTransforms: The transforms that trigger these events.  

      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 PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      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:
      EventBrokers
      TriggeredTransforms
      TriggeringTransforms
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      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.

    • getEventRole

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

    • getEventRoleState

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

    • getEventRoleMaxLength

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

    • getEventBrokers

      AssociationList getEventBrokers() throws RemoteException, MdException
      Gets the AssociationList of EventBrokers
      Returns:
      Returns the AssociationList of EventBrokers which can be of type:
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTriggeredTransforms

      AssociationList getTriggeredTransforms() throws RemoteException, MdException
      Gets the AssociationList of TriggeredTransforms
      Returns:
      Returns the AssociationList of TriggeredTransforms which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTriggeringTransforms

      AssociationList getTriggeringTransforms() throws RemoteException, MdException
      Gets the AssociationList of TriggeringTransforms
      Returns:
      Returns the AssociationList of TriggeringTransforms which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getEventBrokers

      AssociationList getEventBrokers(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of EventBrokers
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of EventBrokers which can be of type:
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTriggeredTransforms

      AssociationList getTriggeredTransforms(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TriggeredTransforms
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of TriggeredTransforms which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTriggeringTransforms

      AssociationList getTriggeringTransforms(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TriggeringTransforms
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of TriggeringTransforms which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the 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.

    • setEventRole

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

    • setEventRole

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

    • setEventRoleState

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

    • setEventBrokers

      void setEventBrokers(AssociationList list) throws RemoteException
      Sets the EventBrokers list to be list. Objects of which can be of type:
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setEventBrokers

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

    • setTriggeredTransforms

      void setTriggeredTransforms(AssociationList list) throws RemoteException
      Sets the TriggeredTransforms list to be list. Objects of which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setTriggeredTransforms

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

    • setTriggeringTransforms

      void setTriggeringTransforms(AssociationList list) throws RemoteException
      Sets the TriggeringTransforms list to be list. Objects of which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setTriggeringTransforms

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