com.sas.metadata.remote
Interface ExternalIdentity

All Superinterfaces:

CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, java.rmi.Remote, Root, SecondaryType

public interface ExternalIdentity
extends SecondaryType

This is an ID associated with the object in some other context, such as a GUID or DN for LDAP .

Attributes of ExternalIdentity are:

• Context
• Identifier
• ImportType

Associations of ExternalIdentity are:

• OwningObject

Usage

To create an instance of this ExternalIdentity, use the factory create methods.
Example: create a ExternalIdentity with name "ExternalIdentity_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();
 ExternalIdentity myObject = (ExternalIdentity) factory.createComplexMetadataObject(objectStore, "ExternalIdentity_Object", MetadataObjects.EXTERNALIDENTITY, "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 Summary

static java.lang.String	ASSOCIATION_OWNINGOBJECT_NAME Constant used for the name of the OwningObject association.
static java.lang.String	ATTRIBUTE_CONTEXT_NAME Constant used for the name of the Context attribute.
static java.lang.String	ATTRIBUTE_IDENTIFIER_NAME Constant used for the name of the Identifier attribute.
static java.lang.String	ATTRIBUTE_IMPORTTYPE_NAME Constant used for the name of the ImportType attribute.

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

abstract java.lang.String	getContext() Gets the String value of Context
abstract int	getContextMaxLength() Gets the maximum length of Context
abstract int	getContextState() Gets the Metadata State of Context
abstract java.lang.String	getIdentifier() Gets the String value of Identifier
abstract int	getIdentifierMaxLength() Gets the maximum length of Identifier
abstract int	getIdentifierState() Gets the Metadata State of Identifier
abstract java.lang.String	getImportType() Gets the String value of ImportType
abstract int	getImportTypeMaxLength() Gets the maximum length of ImportType
abstract int	getImportTypeState() Gets the Metadata State of ImportType
abstract Root	getOwningObject() Gets the Root for OwningObject
abstract AssociationList	getOwningObjects() Gets the AssociationList of OwningObjects
abstract AssociationList	getOwningObjects(boolean fGoToServer) Gets the Associationlist of OwningObjects
abstract void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are: OwningObject
abstract void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are: OwningObject
abstract void	setContext(java.lang.String inContext) Sets the Context value and sets the state to MetadataState.LOCAL.
abstract void	setContext(java.lang.String inContext, int state) Sets the Context Metadata State.
abstract void	setContextState(int state) Sets the Metadata State of Context.
abstract void	setIdentifier(java.lang.String inIdentifier) Sets the Identifier value and sets the state to MetadataState.LOCAL.
abstract void	setIdentifier(java.lang.String inIdentifier, int state) Sets the Identifier Metadata State.
abstract void	setIdentifierState(int state) Sets the Metadata State of Identifier.
abstract void	setImportType(java.lang.String inImportType) Sets the ImportType value and sets the state to MetadataState.LOCAL.
abstract void	setImportType(java.lang.String inImportType, int state) Sets the ImportType Metadata State.
abstract void	setImportTypeState(int state) Sets the Metadata State of ImportType.
abstract void	setOwningObject(Root inObject) Sets the OwningObjects list 0th element to be inObject.
abstract void	setOwningObjects(AssociationList list) Sets the OwningObjects list to be list.
abstract void	setOwningObjects(AssociationList list, int state) Sets the OwningObjects list to be list.

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_CONTEXT_NAME

static final java.lang.String ATTRIBUTE_CONTEXT_NAME

Constant used for the name of the Context attribute.

Context: The context for this ID, such as GUID, LDAP DN, or OM repository ID.

See Also:

Constant Field Values

ATTRIBUTE_IDENTIFIER_NAME

static final java.lang.String ATTRIBUTE_IDENTIFIER_NAME

Constant used for the name of the Identifier attribute.

Identifier: The identifier in the originating context.

See Also:

Constant Field Values

ATTRIBUTE_IMPORTTYPE_NAME

static final java.lang.String ATTRIBUTE_IMPORTTYPE_NAME

Constant used for the name of the ImportType attribute.

ImportType: How the owning object was created. such as Copy, Import

See Also:

Constant Field Values

ASSOCIATION_OWNINGOBJECT_NAME

static final java.lang.String ASSOCIATION_OWNINGOBJECT_NAME

Constant used for the name of the OwningObject association.

OwningObject: The object that had this ID in another context.

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

(S) This initializes the Required Objects(Roles) which are:
OwningObject

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:
OwningObject

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.

getContext

java.lang.String getContext()
                            throws java.rmi.RemoteException

Gets the String value of Context

Returns:

The Context

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getContextState

int getContextState()
                    throws java.rmi.RemoteException

Gets the Metadata State of Context

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getContextMaxLength

int getContextMaxLength()
                        throws java.rmi.RemoteException

Gets the maximum length of Context

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getIdentifier

java.lang.String getIdentifier()
                               throws java.rmi.RemoteException

Gets the String value of Identifier

Returns:

The Identifier

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getIdentifierState

int getIdentifierState()
                       throws java.rmi.RemoteException

Gets the Metadata State of Identifier

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getIdentifierMaxLength

int getIdentifierMaxLength()
                           throws java.rmi.RemoteException

Gets the maximum length of Identifier

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getImportType

java.lang.String getImportType()
                               throws java.rmi.RemoteException

Gets the String value of ImportType

Returns:

The ImportType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getImportTypeState

int getImportTypeState()
                       throws java.rmi.RemoteException

Gets the Metadata State of ImportType

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getImportTypeMaxLength

int getImportTypeMaxLength()
                           throws java.rmi.RemoteException

Gets the maximum length of ImportType

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getOwningObjects

AssociationList getOwningObjects()
                                 throws java.rmi.RemoteException,
                                        MdException

Gets the AssociationList of OwningObjects

Returns:

Returns the AssociationList of OwningObjects which can be of type:
All types

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException

getOwningObject

Root getOwningObject()
                     throws java.rmi.RemoteException,
                            MdException

Gets the Root for OwningObject

Returns:

The Root ( null if not set) of OwningObjectwhich can be of type:
All types

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getOwningObjects

AssociationList getOwningObjects(boolean fGoToServer)
                                 throws java.rmi.RemoteException,
                                        MdException

Gets the Associationlist of OwningObjects

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of OwningObjects which can be of type:
All types

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

setContext

void setContext(java.lang.String inContext)
                throws java.rmi.RemoteException

Sets the Context value and sets the state to MetadataState.LOCAL.

Parameters:

inContext - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setContext

void setContext(java.lang.String inContext,
                int state)
                throws java.rmi.RemoteException

Sets the Context Metadata State.

Parameters:

inContext - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setContextState

void setContextState(int state)
                     throws java.rmi.RemoteException

Sets the Metadata State of Context.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setIdentifier

void setIdentifier(java.lang.String inIdentifier)
                   throws java.rmi.RemoteException

Sets the Identifier value and sets the state to MetadataState.LOCAL.

Parameters:

inIdentifier - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setIdentifier

void setIdentifier(java.lang.String inIdentifier,
                   int state)
                   throws java.rmi.RemoteException

Sets the Identifier Metadata State.

Parameters:

inIdentifier - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setIdentifierState

void setIdentifierState(int state)
                        throws java.rmi.RemoteException

Sets the Metadata State of Identifier.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setImportType

void setImportType(java.lang.String inImportType)
                   throws java.rmi.RemoteException

Sets the ImportType value and sets the state to MetadataState.LOCAL.

Parameters:

inImportType - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setImportType

void setImportType(java.lang.String inImportType,
                   int state)
                   throws java.rmi.RemoteException

Sets the ImportType Metadata State.

Parameters:

inImportType - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setImportTypeState

void setImportTypeState(int state)
                        throws java.rmi.RemoteException

Sets the Metadata State of ImportType.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningObjects

void setOwningObjects(AssociationList list)
                      throws java.rmi.RemoteException

Sets the OwningObjects list to be list. Object of which can be of type:
All types

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningObjects

void setOwningObjects(AssociationList list,
                      int state)
                      throws java.rmi.RemoteException

Sets the OwningObjects list to be list. Object of which can be of type:
All types

Parameters:

list - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningObject

void setOwningObject(Root inObject)
                     throws java.rmi.RemoteException

Sets the OwningObjects list 0th element to be inObject.

Parameters:

inObject - Root

Throws:

java.rmi.RemoteException - If error communicating with remote object.