com.sas.metadata.remote
Interface Extension
All Superinterfaces: AbstractExtension , CMetadata , MdObjectBase , MdObjectBaseUtil , MdObjectBaseXML , java.rmi.Remote , Root , SecondaryType
public interface Extension extends AbstractExtension
Extension enables end users and application developers to define additional attributes that are not part of an object's metadata type definition. Use the Extension metadata type to define attributes that store character values.
Attributes of Extension are:
Associations of Extension are:
Usage
To create an instance of this Extension, use the factory
create methods.
Example: create a Extension with name "Extension_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();
Extension myObject = (Extension) factory.createComplexMetadataObject(objectStore, "Extension_Object", MetadataObjects.EXTENSION, "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
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
Methods inherited from interface com.sas.metadata.remote.AbstractExtension
getExtensionType , getExtensionTypeMaxLength , getExtensionTypeState , getOwningObject , getOwningObjects , getOwningObjects , setExtensionType , setExtensionType , setExtensionTypeState , setOwningObject , setOwningObjects , setOwningObjects
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
ATTRIBUTE_VALUE_NAME
static final java.lang.String ATTRIBUTE_VALUE_NAME
Constant used for the name of the Value attribute.
Value: This is the actual value of the extension in character format.
See Also: Constant Field Values
initializeRequiredObjects
void initializeRequiredObjects ()
throws java.rmi.RemoteException
(S) This initializes the Required Objects(Roles) which are:
Specified by: initializeRequiredObjects
in interface AbstractExtension
Specified by: initializeRequiredObjects
in interface MdObjectBaseUtil
Specified by: initializeRequiredObjects
in interface Root
Specified by: initializeRequiredObjects
in interface SecondaryType
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:
Specified by: initializePredObjects
in interface AbstractExtension
Specified by: initializePredObjects
in interface MdObjectBase
Specified by: initializePredObjects
in interface Root
Specified by: initializePredObjects
in interface SecondaryType
Throws:
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
getValue
java.lang.String getValue ()
throws java.rmi.RemoteException
Gets the String
value of Value
Returns: The Value
Throws:
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
getValueState
int getValueState ()
throws java.rmi.RemoteException
Gets the Metadata State of Value
Returns: The State.
Throws:
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
getValueMaxLength
int getValueMaxLength ()
throws java.rmi.RemoteException
Gets the maximum length of Value
Returns: The max size
Throws:
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
setValue
void setValue (java.lang.String inValue)
throws java.rmi.RemoteException
Sets the Value
value and sets the state to MetadataState.LOCAL.
Parameters: inValue
- String
Throws:
java.rmi.RemoteException
- If error communicating with remote object.
setValue
void setValue (java.lang.String inValue,
int state)
throws java.rmi.RemoteException
Sets the Value
Metadata State.
Parameters: inValue
- Stringstate
- int
Throws:
java.rmi.RemoteException
- If error communicating with remote object.
setValueState
void setValueState (int state)
throws java.rmi.RemoteException
Sets the Metadata State of Value
.
Parameters: state
- int
Throws:
java.rmi.RemoteException
- If error communicating with remote object.
Copyright © 2009 SAS Institute Inc. All Rights Reserved.