com.sas.metadata.remote
Interface Prototype

All Superinterfaces:

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

public interface Prototype
extends PrimaryType

Used to create a template for creating other metadata objects or set of metadata objects that represent a concept. Any metadata type may be associated with a prototype. The prototype includes all possible valid options or properties that may be used to describe the metadata object that is represented by the prototype. The prototype may then be used to drive a UI that will aid an end user in the creation of metadata. The model allows for any metadata type to be considered a prototype, however, there is currently no defined way to specify that the given metadata object is a prototype that does not represent a particular entity. It is recommended that only metadata types that have a role attribute be considered candidates for defining new prototypes. The role attribute is typically used by clients to filter the metadata before displaying to end users.

Attributes of Prototype are:

• MetadataType

Associations of Prototype are:

• Associations
• PrototypeProperties

Usage

To create an instance of this Prototype, use the factory create methods.
Example: create a Prototype with name "Prototype_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();
 Prototype myObject = (Prototype) factory.createComplexMetadataObject(objectStore, "Prototype_Object", MetadataObjects.PROTOTYPE, "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_ASSOCIATIONS_NAME Constant used for the name of the Associations association.
static java.lang.String	ASSOCIATION_PROTOTYPEPROPERTIES_NAME Constant used for the name of the PrototypeProperties association.
static java.lang.String	ATTRIBUTE_METADATATYPE_NAME Constant used for the name of the MetadataType 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

AssociationList	getAssociations() Gets the AssociationList of Associations
AssociationList	getAssociations(boolean fGoToServer) Gets the Associationlist of Associations
java.lang.String	getMetadataType() Gets the String value of MetadataType
int	getMetadataTypeMaxLength() Gets the maximum length of MetadataType
int	getMetadataTypeState() Gets the Metadata State of MetadataType
AssociationList	getPrototypeProperties() Gets the AssociationList of PrototypeProperties
AssociationList	getPrototypeProperties(boolean fGoToServer) Gets the Associationlist of PrototypeProperties
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are: Associations PrototypeProperties
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
void	setAssociations(AssociationList list) Sets the Associations list to be list.
void	setAssociations(AssociationList inObjects, int state) Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
void	setMetadataType(java.lang.String inMetadataType) Sets the MetadataType value and sets the state to MetadataState.LOCAL.
void	setMetadataType(java.lang.String inMetadataType, int state) Sets the MetadataType Metadata State.
void	setMetadataTypeState(int state) Sets the Metadata State of MetadataType.
void	setPrototypeProperties(AssociationList list) Sets the PrototypeProperties list to be list.
void	setPrototypeProperties(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_METADATATYPE_NAME

static final java.lang.String ATTRIBUTE_METADATATYPE_NAME

Constant used for the name of the MetadataType attribute.

MetadataType: The metadata type that is described by this prototype. For example, a TCPIPConnection, SoftwareComponent, SASLibrary.

See Also:

Constant Field Values

ASSOCIATION_ASSOCIATIONS_NAME

static final java.lang.String ASSOCIATION_ASSOCIATIONS_NAME

Constant used for the name of the Associations association.

Associations: The association property objects that are reference this object as the partner in an association.

See Also:

Constant Field Values

ASSOCIATION_PROTOTYPEPROPERTIES_NAME

static final java.lang.String ASSOCIATION_PROTOTYPEPROPERTIES_NAME

Constant used for the name of the PrototypeProperties association.

PrototypeProperties: The attribute and association properties of this prototype.

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:
Associations
PrototypeProperties

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.

getMetadataType

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

Gets the String value of MetadataType

Returns:

The MetadataType

Throws:

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

getMetadataTypeState

int getMetadataTypeState()
                         throws java.rmi.RemoteException

Gets the Metadata State of MetadataType

Returns:

The State.

Throws:

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

getMetadataTypeMaxLength

int getMetadataTypeMaxLength()
                             throws java.rmi.RemoteException

Gets the maximum length of MetadataType

Returns:

The max size

Throws:

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

getAssociations

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

Gets the AssociationList of Associations

Returns:

Returns the AssociationList of Associations which can be of type:
AssociationProperty

Throws:

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

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

getPrototypeProperties

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

Gets the AssociationList of PrototypeProperties

Returns:

Returns the AssociationList of PrototypeProperties which can be of type:
PrototypeProperty
AttributeProperty
AssociationProperty

Throws:

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

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

getAssociations

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

Gets the Associationlist of Associations

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of Associations which can be of type:
AssociationProperty

Throws:

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

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

getPrototypeProperties

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

Gets the Associationlist of PrototypeProperties

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of PrototypeProperties which can be of type:
PrototypeProperty
AttributeProperty
AssociationProperty

Throws:

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

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

setMetadataType

void setMetadataType(java.lang.String inMetadataType)
                     throws java.rmi.RemoteException

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

Parameters:

inMetadataType - String

Throws:

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

setMetadataType

void setMetadataType(java.lang.String inMetadataType,
                     int state)
                     throws java.rmi.RemoteException

Sets the MetadataType Metadata State.

Parameters:

inMetadataType - String

state - int

Throws:

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

setMetadataTypeState

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

Sets the Metadata State of MetadataType.

Parameters:

state - int

Throws:

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

setAssociations

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

Sets the Associations list to be list. Objects of which can be of type:
AssociationProperty

Parameters:

list - AssociationList

Throws:

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

setAssociations

void setAssociations(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.

setPrototypeProperties

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

Sets the PrototypeProperties list to be list. Objects of which can be of type:
PrototypeProperty
AttributeProperty
AssociationProperty

Parameters:

list - AssociationList

Throws:

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

setPrototypeProperties

void setPrototypeProperties(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.