Package com.sas.metadata.remote
Interface Report
- All Superinterfaces:
Classifier,CMetadata,MdObjectBase,MdObjectBaseUtil,MdObjectBaseXML,PrimaryType,Remote,Root
Represents the result of data being transformed into a report. The report has an association to a physical location, such as a SAS catalog entry or file.
Example: create a Report with name "Report_Object", in repository "AAAAAAAA".
Attributes of Report are:
Associations of Report are:
Usage
To create an instance of this Report, use thefactory
create methods. Example: create a Report with name "Report_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(); Report myObject = (Report) factory.createComplexMetadataObject(objectStore, "Report_Object", MetadataObjects.REPORT, "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
updateMetadataAllmethod. - If an object needs to be deleted, the
deletemethod 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
FieldsModifier and TypeFieldDescriptionstatic final StringConstant used for the name of the FileRefs association.static final StringConstant used for the name of the ReportLocation association.static final StringConstant used for the name of the ReportType attribute.Fields inherited from interface com.sas.metadata.remote.Classifier
ASSOCIATION_SOURCECLASSIFIERMAPS_NAME, ASSOCIATION_TARGETCLASSIFIERMAPS_NAMEFields inherited from interface com.sas.metadata.remote.MdObjectBase
ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAMEFields inherited from interface com.sas.metadata.remote.PrimaryType
ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAMEFields 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 -
Method Summary
Modifier and TypeMethodDescriptionGets the Association list ofFileRefsgetFileRefs(boolean fGoToServer) Gets the Associationlist ofFileRefsGets theContentLocationforReportLocationGets the AssociationList ofReportLocationsgetReportLocations(boolean fGoToServer) Gets the Associationlist ofReportLocationsStringGets theStringvalue ofReportTypeintGets the maximum length ofReportTypeintGets the Metadata State ofReportTypevoid(S) Adds the Associated objects to the predObjects which are:
ReportLocationvoid(S) This initializes the Required Objects(Roles) which are:voidsetFileRefs(AssociationList list) Sets theFileRefslist to belist.voidsetFileRefs(AssociationList inObjects, int state) Sets the entire FileRefs list to match the passed in AssociationList, sets the state of the FileRefsvoidsetReportLocation(ContentLocation inObject) Sets theReportLocationslist 0th element to beinObject.voidSets theReportLocationslist to belist.voidsetReportLocations(AssociationList list, int state) Sets theReportLocationslist to belist.voidsetReportType(String inReportType) Sets theReportTypevalue and sets the state to MetadataState.LOCAL.voidsetReportType(String inReportType, int state) Sets theReportTypeMetadata State.voidsetReportTypeState(int state) Sets the Metadata State ofReportType.Methods inherited from interface com.sas.metadata.remote.Classifier
getSourceClassifierMaps, getSourceClassifierMaps, getTargetClassifierMaps, getTargetClassifierMaps, setSourceClassifierMaps, setSourceClassifierMaps, setTargetClassifierMaps, setTargetClassifierMapsMethods 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, setStateMethods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil
addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getAuthorizationUtil, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIdsMethods inherited from interface com.sas.metadata.remote.MdObjectBaseXML
closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAllMethods inherited from interface com.sas.metadata.remote.PrimaryType
getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeStateMethods 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
-
Field Details
-
ATTRIBUTE_REPORTTYPE_NAME
static final String ATTRIBUTE_REPORTTYPE_NAMEConstant used for the name of the ReportType attribute.ReportType: ReportType
- See Also:
-
ASSOCIATION_REPORTLOCATION_NAME
static final String ASSOCIATION_REPORTLOCATION_NAMEConstant used for the name of the ReportLocation association.ReportLocation: The location of this report.
- See Also:
-
ASSOCIATION_FILEREFS_NAME
static final String ASSOCIATION_FILEREFS_NAMEConstant used for the name of the FileRefs association.FileRefs: The FileRefs that are used to generate this report.
- See Also:
-
-
Method Details
-
initializeRequiredObjects
void initializeRequiredObjects() throws RemoteException(S) This initializes the Required Objects(Roles) which are:- Specified by:
initializeRequiredObjectsin interfaceClassifier- Specified by:
initializeRequiredObjectsin interfaceMdObjectBaseUtil- Specified by:
initializeRequiredObjectsin interfacePrimaryType- Specified by:
initializeRequiredObjectsin interfaceRoot- 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:
ReportLocation- Specified by:
initializePredObjectsin interfaceClassifier- Specified by:
initializePredObjectsin interfaceMdObjectBase- Specified by:
initializePredObjectsin interfacePrimaryType- Specified by:
initializePredObjectsin interfaceRoot- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getReportType
String getReportType() throws RemoteExceptionGets theStringvalue ofReportType- Returns:
- The
ReportType - Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getReportTypeState
int getReportTypeState() throws RemoteExceptionGets the Metadata State ofReportType- Returns:
- The State.
- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getReportTypeMaxLength
int getReportTypeMaxLength() throws RemoteExceptionGets the maximum length ofReportType- Returns:
- The max size
- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getReportLocations
Gets the AssociationList ofReportLocations- Returns:
- Returns the AssociationList of
ReportLocationswhich can be of type:
ContentLocation
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document
Directory
AnalyticContext
Device
Stream
Memory
Connection
SASClientConnection
OpenClientConnection
TCPIPConnection
COMConnection
Email - Throws:
RemoteException- If error connecting/communicating to/with remote object.MdException
-
getReportLocation
Gets theContentLocationforReportLocation- Returns:
- The
ContentLocation(nullif not set) ofReportLocationwhich can be of type:
ContentLocation
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document
Directory
AnalyticContext
Device
Stream
Memory
Connection
SASClientConnection
OpenClientConnection
TCPIPConnection
COMConnection
Email - Throws:
RemoteException- If error connecting/communicating to/with remote object.MdException- If error getting/setting part of the object.
-
getFileRefs
Gets the Association list ofFileRefs- Returns:
- The AssociationList of
FileRefswhich can be of type:
SASFileRef - Throws:
RemoteException- If error connecting/communicating to/with remote object.MdException- If error getting/setting part of the object.
-
getReportLocations
Gets the Associationlist ofReportLocations- Parameters:
fGoToServer- boolean Get the value from the server.- Returns:
- Returns the AssociationList of
ReportLocationswhich can be of type:
ContentLocation
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document
Directory
AnalyticContext
Device
Stream
Memory
Connection
SASClientConnection
OpenClientConnection
TCPIPConnection
COMConnection
Email - Throws:
RemoteException- If error connecting/communicating to/with remote object.MdException- If error getting/setting part of the object.
-
getFileRefs
Gets the Associationlist ofFileRefs- Parameters:
fGoToServer- boolean Get the value from the server.- Returns:
- Returns the
FileRefswhich can be of type:
SASFileRef - Throws:
RemoteException- If error connecting/communicating to/with remote object.MdException- If error getting/setting part of the object.
-
setReportType
void setReportType(String inReportType) throws RemoteException Sets theReportTypevalue and sets the state to MetadataState.LOCAL.- Parameters:
inReportType- String- Throws:
RemoteException- If error communicating with remote object.
-
setReportType
void setReportType(String inReportType, int state) throws RemoteException Sets theReportTypeMetadata State.- Parameters:
inReportType- Stringstate- int- Throws:
RemoteException- If error communicating with remote object.
-
setReportTypeState
void setReportTypeState(int state) throws RemoteException Sets the Metadata State ofReportType.- Parameters:
state- int- Throws:
RemoteException- If error communicating with remote object.
-
setReportLocations
Sets theReportLocationslist to belist. Object of which can be of type:
ContentLocation
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document
Directory
AnalyticContext
Device
Stream
Memory
Connection
SASClientConnection
OpenClientConnection
TCPIPConnection
COMConnection
Email- Parameters:
list- AssociationList- Throws:
RemoteException- If error communicating with remote object.
-
setReportLocations
Sets theReportLocationslist to belist. Object of which can be of type:
ContentLocation
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document
Directory
AnalyticContext
Device
Stream
Memory
Connection
SASClientConnection
OpenClientConnection
TCPIPConnection
COMConnection
Email- Parameters:
list- AssociationListstate- int- Throws:
RemoteException- If error communicating with remote object.
-
setReportLocation
Sets theReportLocationslist 0th element to beinObject.- Parameters:
inObject- ContentLocation- Throws:
RemoteException- If error communicating with remote object.
-
setFileRefs
- Parameters:
list- AssociationList- Throws:
RemoteException- If error communicating with remote object.
-
setFileRefs
Sets the entire FileRefs list to match the passed in AssociationList, sets the state of the FileRefs- Parameters:
inObjects- AssociationListstate- int- Throws:
RemoteException- If error communicating with remote object.
-