com.sas.services.information.metadata
Interface SoftwareComponentInterface

All Superinterfaces:

MetadataInterface, PublicObjectInterface, java.rmi.Remote

All Known Subinterfaces:

ApplicationInterface, ConfiguredComponentInterface, ConnectServerInterface, ConnectSpawnerInterface, DataStepBatchServerInterface, FtpServerInterface, GridMonitoringServerInterface, HttpServerInterface, JavaBatchServerInterface, LogicalConnectServerInterface, LogicalDataStepBatchServerInteface, LogicalGridServerInterface, LogicalJavaBatchServerInterface, LogicalOSServerInterface, LogicalServerInterface, MSMQQueueManagerInterface, OperatingSystemServerInterface, OracleServerInterface, ProxyListInterface, QueueManagerInterface, SasInProcessServerInterface, ServerComponentInterface, ServerContextInterface, ServerInterface, ShareServerInterface, SPDSServerInterface, TableServerInterface, WebsphereQueueManagerInterface

All Known Implementing Classes:

Application, OMRDatabaseServer, OMRHadoopServer, OMRPostgresServer, OMRProxyList, OMRSAPServer, com.sas.services.information.metadata.OMRServer, com.sas.services.information.metadata.OMRServerComponent, com.sas.services.information.metadata.OMRSoftwareComponent, OMRSPDSServer

public interface SoftwareComponentInterface
extends MetadataInterface

Field Summary

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

abstract void	addDeployedComponent(ServerInterface server) Add a DeployedComponent to this SoftwareComponent.
abstract void	addPropertyGroup(PropertyGroupInterface group) Add a PropertyGroupInterface object to this SoftwareComponent.
abstract void	addSoftwareGroup(GroupInterface group) Add a SoftwareGroup to this SoftwareComponent.
abstract void	addSoftwareTree(FolderInterface folder) Add a SoftwareTree to this SoftwareComponent.
abstract java.lang.String	getClassIdentifier() Get the unique class identifier for the software.
abstract java.util.List	getDependentComponents() Get the components that depend on this one.
abstract java.util.List	getDependsOnComponents() Get the components that this component depends on.
abstract java.util.List	getDeployedComponents() Get the list of DeployedComponents associated to this SoftwareComponent.
abstract java.util.List<MetadataInterface>	getImplementedObjects() Get the list of objects that are implemented by the software described by this SoftwareComponent.
abstract int	getMajor() Get the major release number as an integer.
abstract int	getMinor() Get the minor release number as an integer.
abstract java.lang.String	getPlatform() Get the platform or language of the SoftwareComponent.
abstract java.util.Map<java.lang.String,java.lang.String>	getPrivateConfigurableProperties()
abstract java.lang.String	getProductIdentifier() An ID representing the product.
abstract java.lang.String	getProductName() Get the name of the product this software comprises or is bundled with.
abstract java.util.List	getPropertyGroups() Get the List of PropertyGroupInterface objects associated with this SoftwareComponent.
abstract java.util.Map<java.lang.String,java.lang.String>	getPublicConfigurableProperties()
abstract SoftwareComponentAttributes	getSoftwareComponentAttributes() Get the attributes of this component in a SoftwareComponentAttributes object.
abstract java.util.List	getSoftwareGroups() Get the SoftwareGroups for this SoftwareComponent.
abstract java.util.List	getSoftwareTrees() Get the List of SoftwareTrees for this SoftwareComponent.
abstract java.lang.String	getSoftwareVersion() Get the software version of the SoftwareComponent.
abstract java.lang.String	getSpecVendor() Get the name of the vendor that provided the specification.
abstract java.lang.String	getSpecVersion() Get the specification number implemented by the SoftwareComponent.
abstract java.lang.String	getVendor() Get the String with the vendor name.
abstract java.lang.String	getVendorIdentifier() Get the ID representing the software vendor.
abstract void	removeDeployedComponent(ServerInterface server) Remove a DeployedComponent from this SoftwareComponent.
abstract void	removePropertyGroup(PropertyGroupInterface group) Remove a PropertyGroupInterface object from the associated list.
abstract void	removeSoftwareGroup(GroupInterface group) Remove a SoftwareGroup from this SoftwareComponent.
abstract void	removeSoftwareTree(FolderInterface folder) Remove a Software tree from this SoftwareComponent.
abstract void	setClassIdentifier(java.lang.String classIdentifier) Set the class identifier for this SoftwareComponent.
abstract void	setDeployedComponents(java.util.List servers) Set the List DeployedComponents on this SoftwareComponent.
abstract void	setImplementedObjects(java.util.List<MetadataInterface> objects) Set the list of objects that are implemented by the software component described by this object.
abstract void	setMajor(int major) Set the major release number.
abstract void	setMinor(int minor) Set the minor release number.
abstract void	setPlatform(java.lang.String platform) Set the component platform.
abstract void	setProductIdentifier(java.lang.String productIdentifier) Set the product ID for this component.
abstract void	setProductName(java.lang.String productName) Set the name of the product this software is part of.
abstract void	setPropertyGroups(java.util.List groups) Set the list of associated PropertyGroupInterface objects.
abstract void	setSoftwareComponentAttributes(SoftwareComponentAttributes attributes) Set the attributes of this component using a SoftwareComponentAttributes object.
abstract void	setSoftwareGroups(java.util.List groups) Set the List of SoftwareGroups on this SoftwareComponent.
abstract void	setSoftwareTrees(java.util.List folders) Set the List of SoftwareTrees on this SoftwareComponent.
abstract void	setSoftwareVersion(java.lang.String version) Set the software version of the SoftwareComponent.
abstract void	setSpecVendor(java.lang.String specVendor) Set the name of the vendor that provided the specification.
abstract void	setSpecVersion(java.lang.String specVersion) Set the specification number implemented by the Software Component.
abstract void	setVendor(java.lang.String vendor) Set the vendor name string for the Software Component.
abstract void	setVendorIdentifier(java.lang.String vendorIdentifier) Set the ID representing the software vendor.

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getType, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor

Method Detail

getSoftwareVersion

java.lang.String getSoftwareVersion()
                                    throws ServiceException,
                                           java.rmi.RemoteException

Get the software version of the SoftwareComponent.

Returns:

The software version as a string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setSoftwareVersion

void setSoftwareVersion(java.lang.String version)
                        throws ServiceException,
                               java.rmi.RemoteException

Set the software version of the SoftwareComponent.

Parameters:

version - The software version string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getMajor

int getMajor()
             throws ServiceException,
                    java.rmi.RemoteException

Get the major release number as an integer.

Returns:

The major release number.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setMajor

void setMajor(int major)
              throws ServiceException,
                     java.rmi.RemoteException

Set the major release number.

Parameters:

major - The integer representing the major release number.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getMinor

int getMinor()
             throws ServiceException,
                    java.rmi.RemoteException

Get the minor release number as an integer.

Returns:

The minor release number

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setMinor

void setMinor(int minor)
              throws ServiceException,
                     java.rmi.RemoteException

Set the minor release number.

Parameters:

minor - The integer representing the minor release number.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getVendor

java.lang.String getVendor()
                           throws ServiceException,
                                  java.rmi.RemoteException

Get the String with the vendor name.

Returns:

A String containing the vendor's name.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setVendor

void setVendor(java.lang.String vendor)
               throws ServiceException,
                      java.rmi.RemoteException

Set the vendor name string for the Software Component.

Parameters:

vendor - A String containing the vendor's name.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getSpecVersion

java.lang.String getSpecVersion()
                                throws ServiceException,
                                       java.rmi.RemoteException

Get the specification number implemented by the SoftwareComponent.

Returns:

The specification number represented by a String.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setSpecVersion

void setSpecVersion(java.lang.String specVersion)
                    throws ServiceException,
                           java.rmi.RemoteException

Set the specification number implemented by the Software Component.

Parameters:

specVersion - A String with the specification number.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getSpecVendor

java.lang.String getSpecVendor()
                               throws ServiceException,
                                      java.rmi.RemoteException

Get the name of the vendor that provided the specification.

Returns:

The name of the specification vendor.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setSpecVendor

void setSpecVendor(java.lang.String specVendor)
                   throws ServiceException,
                          java.rmi.RemoteException

Set the name of the vendor that provided the specification.

Parameters:

specVendor - The name of the specification vendor.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getVendorIdentifier

java.lang.String getVendorIdentifier()
                                     throws ServiceException,
                                            java.rmi.RemoteException

Get the ID representing the software vendor.

Returns:

The ID String of the software vendor.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setVendorIdentifier

void setVendorIdentifier(java.lang.String vendorIdentifier)
                         throws ServiceException,
                                java.rmi.RemoteException

Set the ID representing the software vendor.

Parameters:

vendorIdentifier - A string with the ID of the software vendor.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getClassIdentifier

java.lang.String getClassIdentifier()
                                    throws ServiceException,
                                           java.rmi.RemoteException

Get the unique class identifier for the software. The class identifier should uniquely identify the type of software this SoftwareComponent represents.

Returns:

The classidentifier String.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setClassIdentifier

void setClassIdentifier(java.lang.String classIdentifier)
                        throws ServiceException,
                               java.rmi.RemoteException

Set the class identifier for this SoftwareComponent. The class identifier should uniquely identify the type of software this component represents.

Parameters:

classIdentifier - The class identifier string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getProductName

java.lang.String getProductName()
                                throws ServiceException,
                                       java.rmi.RemoteException

Get the name of the product this software comprises or is bundled with.

Returns:

The product name.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setProductName

void setProductName(java.lang.String productName)
                    throws ServiceException,
                           java.rmi.RemoteException

Set the name of the product this software is part of.

Parameters:

productName - The product name string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getPlatform

java.lang.String getPlatform()
                             throws ServiceException,
                                    java.rmi.RemoteException

Get the platform or language of the SoftwareComponent.

Returns:

The component platform String.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setPlatform

void setPlatform(java.lang.String platform)
                 throws ServiceException,
                        java.rmi.RemoteException

Set the component platform. This is the platform or language. Examples are COM or Java.

Parameters:

platform - The platform String.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getProductIdentifier

java.lang.String getProductIdentifier()
                                      throws ServiceException,
                                             java.rmi.RemoteException

An ID representing the product.

Returns:

The ID string representing this component's product.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setProductIdentifier

void setProductIdentifier(java.lang.String productIdentifier)
                          throws ServiceException,
                                 java.rmi.RemoteException

Set the product ID for this component.

Parameters:

productIdentifier - The ID of the product this component belongs to.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getSoftwareComponentAttributes

SoftwareComponentAttributes getSoftwareComponentAttributes()
                                                           throws ServiceException,
                                                                  java.rmi.RemoteException

Get the attributes of this component in a SoftwareComponentAttributes object.

Returns:

The component attributes.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setSoftwareComponentAttributes

void setSoftwareComponentAttributes(SoftwareComponentAttributes attributes)
                                    throws ServiceException,
                                           java.rmi.RemoteException

Set the attributes of this component using a SoftwareComponentAttributes object.

Parameters:

attributes - The new attributes of this SoftwareComponent. Any non-null String will replace the current value, and any integer > 0.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getSoftwareGroups

java.util.List getSoftwareGroups()
                                 throws ServiceException,
                                        java.rmi.RemoteException

Get the SoftwareGroups for this SoftwareComponent.

Returns:

A List of GroupInterface objects.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addSoftwareGroup

void addSoftwareGroup(GroupInterface group)
                      throws ServiceException,
                             java.rmi.RemoteException

Add a SoftwareGroup to this SoftwareComponent.

Parameters:

group - A new GroupInterface to add as a SoftwareGroup.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removeSoftwareGroup

void removeSoftwareGroup(GroupInterface group)
                         throws ServiceException,
                                java.rmi.RemoteException

Remove a SoftwareGroup from this SoftwareComponent.

Parameters:

group - The Group to remove from the SoftwareGroups.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setSoftwareGroups

void setSoftwareGroups(java.util.List groups)
                       throws ServiceException,
                              java.rmi.RemoteException

Set the List of SoftwareGroups on this SoftwareComponent. If the list is null or empty, all SoftwareGroups will be disassociated.

Parameters:

groups - The list of GroupInterface objects to associate to this SoftwareComponent as SoftwareGroups.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getSoftwareTrees

java.util.List getSoftwareTrees()
                                throws ServiceException,
                                       java.rmi.RemoteException

Get the List of SoftwareTrees for this SoftwareComponent.

Returns:

A List of FolderInterface objects representing the SoftwareTrees.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addSoftwareTree

void addSoftwareTree(FolderInterface folder)
                     throws ServiceException,
                            java.rmi.RemoteException

Add a SoftwareTree to this SoftwareComponent.

Parameters:

folder - A FolderInterface object to add as a SoftwareTree.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removeSoftwareTree

void removeSoftwareTree(FolderInterface folder)
                        throws ServiceException,
                               java.rmi.RemoteException

Remove a Software tree from this SoftwareComponent.

Parameters:

folder - The FolderInterface to remove from the SoftwareTrees.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setSoftwareTrees

void setSoftwareTrees(java.util.List folders)
                      throws ServiceException,
                             java.rmi.RemoteException

Set the List of SoftwareTrees on this SoftwareComponent. If the list is null or empty, all SoftwareTrees will be disassociated.

Parameters:

folders - The List of FolderInterface objects to associate to this SoftwareComponent as SoftwareTrees.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getDeployedComponents

java.util.List getDeployedComponents()
                                     throws ServiceException,
                                            java.rmi.RemoteException

Get the list of DeployedComponents associated to this SoftwareComponent.

Returns:

A List of ServerInterface objects representing the DeployedComponents on this SoftwareComponent.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addDeployedComponent

void addDeployedComponent(ServerInterface server)
                          throws ServiceException,
                                 java.rmi.RemoteException

Add a DeployedComponent to this SoftwareComponent.

Parameters:

server - The ServerInterface object to add as a DeployedComponent on this SoftwareComponent.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removeDeployedComponent

void removeDeployedComponent(ServerInterface server)
                             throws ServiceException,
                                    java.rmi.RemoteException

Remove a DeployedComponent from this SoftwareComponent.

Parameters:

server - The ServerInterface object to remove from the DeployedComponents.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setDeployedComponents

void setDeployedComponents(java.util.List servers)
                           throws ServiceException,
                                  java.rmi.RemoteException

Set the List DeployedComponents on this SoftwareComponent. If the list is null or empty, all DeployedComponents will be disassociated.

Parameters:

servers - The List of ServerInterface objects to associate to this SoftwareComponent as DeployedComponents.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getPropertyGroups

java.util.List getPropertyGroups()
                                 throws ServiceException,
                                        java.rmi.RemoteException

Get the List of PropertyGroupInterface objects associated with this SoftwareComponent.

Returns:

A List of PropertyGroupInterface objects associated to this SoftwareComponent.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addPropertyGroup

void addPropertyGroup(PropertyGroupInterface group)
                      throws ServiceException,
                             java.rmi.RemoteException

Add a PropertyGroupInterface object to this SoftwareComponent.

Parameters:

group - A PropertyGroupInterface object to associate to this SoftwareComponent.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removePropertyGroup

void removePropertyGroup(PropertyGroupInterface group)
                         throws ServiceException,
                                java.rmi.RemoteException

Remove a PropertyGroupInterface object from the associated list.

Parameters:

group - A PropertyGroupInterface object to remove from the associated list.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setPropertyGroups

void setPropertyGroups(java.util.List groups)
                       throws ServiceException,
                              java.rmi.RemoteException

Set the list of associated PropertyGroupInterface objects.

Parameters:

groups - A List of associated PropertyGroupInterface objects.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getDependentComponents

java.util.List getDependentComponents()
                                      throws ServiceException,
                                             java.rmi.RemoteException

Get the components that depend on this one. This association is going "down" the dependency chain.

Returns:

A List of SoftwareComponentInterface objects that depend on this one.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getDependsOnComponents

java.util.List getDependsOnComponents()
                                      throws ServiceException,
                                             java.rmi.RemoteException

Get the components that this component depends on. This association is going "up" the dependency chain.

Returns:

A List of SoftwareComponentInterface objects that this one depends on.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getPublicConfigurableProperties

java.util.Map<java.lang.String,java.lang.String> getPublicConfigurableProperties()
                                                                                 throws ServiceException,
                                                                                        java.rmi.RemoteException

Throws:

ServiceException

java.rmi.RemoteException

getPrivateConfigurableProperties

java.util.Map<java.lang.String,java.lang.String> getPrivateConfigurableProperties()
                                                                                  throws ServiceException,
                                                                                         java.rmi.RemoteException

Throws:

ServiceException

java.rmi.RemoteException

getImplementedObjects

java.util.List<MetadataInterface> getImplementedObjects()
                                                        throws ServiceException,
                                                               java.rmi.RemoteException

Get the list of objects that are implemented by the software described by this SoftwareComponent.

Returns:

a List of MetadataInterface objects that are implemented by this component.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setImplementedObjects

void setImplementedObjects(java.util.List<MetadataInterface> objects)
                           throws ServiceException,
                                  java.rmi.RemoteException

Set the list of objects that are implemented by the software component described by this object.

Parameters:

objects - The list of objects implemented by this one.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.