com.sas.metadata.remote
Interface Event

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, java.rmi.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

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 Summary
static java.lang.String ASSOCIATION_EVENTBROKERS_NAME
          Constant used for the name of the EventBrokers association.
static java.lang.String ASSOCIATION_TRIGGEREDTRANSFORMS_NAME
          Constant used for the name of the TriggeredTransforms association.
static java.lang.String ASSOCIATION_TRIGGERINGTRANSFORMS_NAME
          Constant used for the name of the TriggeringTransforms association.
static java.lang.String ATTRIBUTE_CONDITION_NAME
          Constant used for the name of the Condition attribute.
static java.lang.String ATTRIBUTE_EVENTROLE_NAME
          Constant used for the name of the EventRole attribute.
 
Fields inherited from interface com.sas.metadata.remote.PrimaryType
ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME
 
Fields inherited from interface com.sas.metadata.remote.Root
ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME
 
Fields inherited from interface com.sas.metadata.remote.MdObjectBase
ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME
 
Method Summary
 java.lang.String getCondition()
          Gets the String value of Condition
 int getConditionMaxLength()
          Gets the maximum length of Condition
 int getConditionState()
          Gets the Metadata State of Condition
 AssociationList getEventBrokers()
          Gets the AssociationList of EventBrokers
 AssociationList getEventBrokers(boolean fGoToServer)
          Gets the Associationlist of EventBrokers
 java.lang.String getEventRole()
          Gets the String value of EventRole
 int getEventRoleMaxLength()
          Gets the maximum length of EventRole
 int getEventRoleState()
          Gets the Metadata State of EventRole
 AssociationList getTriggeredTransforms()
          Gets the AssociationList of TriggeredTransforms
 AssociationList getTriggeredTransforms(boolean fGoToServer)
          Gets the Associationlist of TriggeredTransforms
 AssociationList getTriggeringTransforms()
          Gets the AssociationList of TriggeringTransforms
 AssociationList getTriggeringTransforms(boolean fGoToServer)
          Gets the Associationlist of TriggeringTransforms
 void initializePredObjects()
          (S) Adds the Associated objects to the predObjects which are:
EventBrokers
TriggeredTransforms
TriggeringTransforms
 void initializeRequiredObjects()
          (S) This initializes the Required Objects(Roles) which are:
 void setCondition(java.lang.String inCondition)
          Sets the Condition value and sets the state to MetadataState.LOCAL.
 void setCondition(java.lang.String inCondition, int state)
          Sets the Condition Metadata State.
 void setConditionState(int state)
          Sets the Metadata State of Condition.
 void setEventBrokers(AssociationList list)
          Sets the EventBrokers list to be list.
 void setEventBrokers(AssociationList inObjects, int state)
          Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
 void setEventRole(java.lang.String inEventRole)
          Sets the EventRole value and sets the state to MetadataState.LOCAL.
 void setEventRole(java.lang.String inEventRole, int state)
          Sets the EventRole Metadata State.
 void setEventRoleState(int state)
          Sets the Metadata State of EventRole.
 void setTriggeredTransforms(AssociationList list)
          Sets the TriggeredTransforms list to be list.
 void setTriggeredTransforms(AssociationList inObjects, int state)
          Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
 void setTriggeringTransforms(AssociationList list)
          Sets the TriggeringTransforms list to be list.
 void setTriggeringTransforms(AssociationList inObjects, int state)
          Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
 
Methods inherited from interface com.sas.metadata.remote.PrimaryType
getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState
 
Methods inherited from interface com.sas.metadata.remote.Root
getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables
 
Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML
closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll
 
Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil
addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds
 
Methods inherited from interface com.sas.metadata.remote.MdObjectBase
addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState
 

Field Detail

ATTRIBUTE_CONDITION_NAME

static final java.lang.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:
Constant Field Values

ATTRIBUTE_EVENTROLE_NAME

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

EventRole: Internal or External

See Also:
Constant Field Values

ASSOCIATION_EVENTBROKERS_NAME

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

EventBrokers: The event brokers for this set of events. 

See Also:
Constant Field Values

ASSOCIATION_TRIGGEREDTRANSFORMS_NAME

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

TriggeredTransforms: The transforms that are triggered by this event. 

See Also:
Constant Field Values

ASSOCIATION_TRIGGERINGTRANSFORMS_NAME

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

TriggeringTransforms: The transforms that trigger these events. 

See Also:
Constant Field Values
Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.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:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.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:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCondition

java.lang.String getCondition()
                              throws java.rmi.RemoteException
Gets the String value of Condition

Returns:
The Condition
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getConditionState

int getConditionState()
                      throws java.rmi.RemoteException
Gets the Metadata State of Condition

Returns:
The State.
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getConditionMaxLength

int getConditionMaxLength()
                          throws java.rmi.RemoteException
Gets the maximum length of Condition

Returns:
The max size
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getEventRole

java.lang.String getEventRole()
                              throws java.rmi.RemoteException
Gets the String value of EventRole

Returns:
The EventRole
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getEventRoleState

int getEventRoleState()
                      throws java.rmi.RemoteException
Gets the Metadata State of EventRole

Returns:
The State.
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getEventRoleMaxLength

int getEventRoleMaxLength()
                          throws java.rmi.RemoteException
Gets the maximum length of EventRole

Returns:
The max size
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getEventBrokers

AssociationList getEventBrokers()
                                throws java.rmi.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:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
MdException - If error getting/setting part of the object.

getTriggeredTransforms

AssociationList getTriggeredTransforms()
                                       throws java.rmi.RemoteException,
                                              MdException
Gets the AssociationList of TriggeredTransforms

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

getTriggeringTransforms

AssociationList getTriggeringTransforms()
                                        throws java.rmi.RemoteException,
                                               MdException
Gets the AssociationList of TriggeringTransforms

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

getEventBrokers

AssociationList getEventBrokers(boolean fGoToServer)
                                throws java.rmi.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:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
MdException - If error getting/setting part of the object.

getTriggeredTransforms

AssociationList getTriggeredTransforms(boolean fGoToServer)
                                       throws java.rmi.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
Transformation
ClassifierMap
Select
Join
AbstractJob
Job
JFJob
MiningResult
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
MdException - If error getting/setting part of the object.

getTriggeringTransforms

AssociationList getTriggeringTransforms(boolean fGoToServer)
                                        throws java.rmi.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
Transformation
ClassifierMap
Select
Join
AbstractJob
Job
JFJob
MiningResult
Throws:
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
MdException - If error getting/setting part of the object.

setCondition

void setCondition(java.lang.String inCondition)
                  throws java.rmi.RemoteException
Sets the Condition value and sets the state to MetadataState.LOCAL.

Parameters:
inCondition - String
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setCondition

void setCondition(java.lang.String inCondition,
                  int state)
                  throws java.rmi.RemoteException
Sets the Condition Metadata State.

Parameters:
inCondition - String
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setConditionState

void setConditionState(int state)
                       throws java.rmi.RemoteException
Sets the Metadata State of Condition.

Parameters:
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setEventRole

void setEventRole(java.lang.String inEventRole)
                  throws java.rmi.RemoteException
Sets the EventRole value and sets the state to MetadataState.LOCAL.

Parameters:
inEventRole - String
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setEventRole

void setEventRole(java.lang.String inEventRole,
                  int state)
                  throws java.rmi.RemoteException
Sets the EventRole Metadata State.

Parameters:
inEventRole - String
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setEventRoleState

void setEventRoleState(int state)
                       throws java.rmi.RemoteException
Sets the Metadata State of EventRole.

Parameters:
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setEventBrokers

void setEventBrokers(AssociationList list)
                     throws java.rmi.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:
java.rmi.RemoteException - If error communicating with remote object.

setEventBrokers

void setEventBrokers(AssociationList inObjects,
                     int state)
                     throws java.rmi.RemoteException
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList

Parameters:
inObjects - AssociationList
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setTriggeredTransforms

void setTriggeredTransforms(AssociationList list)
                            throws java.rmi.RemoteException
Sets the TriggeredTransforms list to be list. Objects of which can be of type:
AbstractTransformation
TransformationStep
SyncStep
TransformationActivity
FeatureMap
Transformation
ClassifierMap
Select
Join
AbstractJob
Job
JFJob
MiningResult

Parameters:
list - AssociationList
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setTriggeredTransforms

void setTriggeredTransforms(AssociationList inObjects,
                            int state)
                            throws java.rmi.RemoteException
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList

Parameters:
inObjects - AssociationList
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setTriggeringTransforms

void setTriggeringTransforms(AssociationList list)
                             throws java.rmi.RemoteException
Sets the TriggeringTransforms list to be list. Objects of which can be of type:
AbstractTransformation
TransformationStep
SyncStep
TransformationActivity
FeatureMap
Transformation
ClassifierMap
Select
Join
AbstractJob
Job
JFJob
MiningResult

Parameters:
list - AssociationList
Throws:
java.rmi.RemoteException - If error communicating with remote object.

setTriggeringTransforms

void setTriggeringTransforms(AssociationList inObjects,
                             int state)
                             throws java.rmi.RemoteException
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList

Parameters:
inObjects - AssociationList
state - int
Throws:
java.rmi.RemoteException - If error communicating with remote object.



Copyright © 2009 SAS Institute Inc. All Rights Reserved.