java.lang.Object

com.sas.services.information.metadata.VirtualMetadata

com.sas.services.information.metadata.VirtualFolder

All Implemented Interfaces:: FolderInterface, MetadataInterface, VirtualFolderInterface, MutableContainerInterface, PublicObjectContainerInterface, PublicObjectInterface, Serializable, Remote

Direct Known Subclasses:: ServerVirtualFolder

@SASScope("ALL") @BinaryCompatibilityOnly public class VirtualFolder extends VirtualMetadata implements VirtualFolderInterface, Serializable

An implementation of a virtual folder. Virtual folders are different from normal folder smart objects in that they do not exist within metadata. Because of this, a virtual folder cannot be modified. In fact, most of the methods in this implementatation throw an UnsupportedOperationException.

A virtual folder should only be managed/created within the VirtualFolderManager class.

Since:

9.3

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

protected Map<String,ProcessorInterface>

_actionInterfaces

protected String

_id

protected List<PublicObjectInterface>

_members

protected String

_name

protected List<SearchFilter>

_origSearchFilters

protected FolderInterface

_parentFolder

The parent folder.

protected RepositoryInterface

_repository

protected Search

_searchManager

protected List<VirtualFolderInterface>

_subFolders

Fields inherited from interface com.sas.services.information.metadata.FolderInterface
FOLDER_TYPE_BIP

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

Modifier and Type

Method

Description

void

addChild(PublicObjectInterface newChild)

Add a child to this container.

void

addItem(MetadataInterface item)

Add an item to the folder.

MetadataInterface

addNewItem(String name, String type)

Create a new metadata object to add to the folder.

void

addSubfolder(FolderInterface folder)

Add an existing folder to this one as a subfolder.

void

addSubfolder(VirtualFolderInterface folder)

Adds a nested virtual folder.

void

deleteItem(MetadataInterface item)

Delete an item from this folder.

void

deleteSubfolder(String name)

Delete a subfolder.

PublicObjectInterface

getChildAt(int index)

Returns a child item at the specified location

int

getChildCount()

Returns the number of children within this container.

List<PublicObjectInterface>

getChildren()

Get a List of the children of this container.

List

getChildren(String type)

Get a list of children of a specific type.

PublicObjectContainerInterface

getContainer()

Get the object which contains this object.

Date

getContentCreateDate()

Get the content create date.

ContentInfo

getContentInfo()

Returns the ContentInfoobject corresponding to the root of the given PathUrl.

Date

getContentModifyDate()

Get the content modification date.

String

getFolderType()

Get the folder type.

String

getIdentifier()

Get the unique ID of this object.

MetadataInterface

getItem(String name)

Get a named item from the folder.

MetadataInterface

getItemByClass(String name, Class itemClass)

Get a named item from the folder.

MetadataInterface

getItemByType(String name, String publicType)

Get a named item from the folder.

List<MetadataInterface>

getItems()

List all items in the folder.

List<MetadataInterface>

getItemsByClass(Class itemClass)

List the items in the folder that match the Class passed in as a parameter.

List<MetadataInterface>

getItemsByType(String metadataType)

Get a list of items in the folder of a specific type.

List

getItemSublist(int start, int end)

Get a sublist of items from this folder

List

getItemSublist(int start, int end, String sort)

Get a sublist of items from this folder which are sorted.

String

getName()

Get the name of this object.

protected List<SearchFilter>

getOriginalFilters()

FolderInterface

getParent()

Return the FolderInterface that contains this object.

String

getPath()

Get path of the current folder.

PathUrl

getPathUrl()

Get the SBIP URL.

ProcessorInterface

getProcessorInterface(String interfaceClassName)

Get the specified action interface.

MetadataInterface

getPublicTypeItem(String name, String type)

Find an item in this Folder with the given name and type.

String

getReposId()

Get the repository ID for the item.

RepositoryInterface

getRepository()

Get the handle to the repository for this object.

Search

getSearchManager()

Returns the search manager that is used to populate the contents of a virtual folder.

FolderInterface

getSubfolder(String name)

Get a named subfolder.

List

getSubfolders()

Get all the folders immediately below this one in the hiearchy.

int

getTotalNumberOfItems()

Get the total number of items in this folder

String

getType()

Get the object type.

TypeDescriptorInterface

getTypeDescriptor()

Get the type descriptor which should have the information from the Type Dictionary in metadata available for the clients.

boolean

hasDuplicate(String name, String type)

Check if there's a duplicate object in this folder with the same name and of the same type.

boolean

hasDuplicateSubfolder(String name)

Check if this folder already has a subfolder with the given name.

void

insertChild(PublicObjectInterface child, int index)

Inserts a child into the parent container at the specified index.

boolean

isEmpty()

Returns true if this folder has no subfolders and no member objects.

boolean

isItemNameUnique(MetadataInterface member)

Validate that the name of the metadata object is unique within the Folder.

FolderInterface

makeSubfolder(String name)

Makes a subfolder under the current folder.

FolderInterface

makeSubfolder(String name, String type)

Make a subfolder of a specific type.

boolean

moveMembersOnOverflow()

Check for too many objects in a folder.

PublicObjectInterface

newChild(String type, String name)

Create a new metadata object and add it to the container.

void

refresh()

Refresh the data for this object from the repository.

void

removeChild(PublicObjectInterface child)

Remove a child from this container.

void

removeItem(MetadataInterface item)

Remove an item from the folder.

void

removeSubfolder(String name)

Remove a subfolder from the current folder.

void

setContentCreateDate(Date date)

Set the Date that the content folder was created.

void

setContentModifyDate(Date date)

Set the date when an object was last added to or removed from this folder.

void

setFolderType(String type)

Set the folder type.

void

setRepository(RepositoryInterface repository)

Set the repository that this item exists in.

void

setSearchManager(Search search)

String

toString()

Methods inherited from class com.sas.services.information.metadata.VirtualMetadata
add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addProcessorInterface, 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, getObjectURI, getParentPath, getParents, getPath, getPaths, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isLoggingEnabled, isObjectAlive, isReadCompatible, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, 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, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, 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, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface
addProcessorInterface, getObjectURI

Field Details
- _parentFolder
  
  protected FolderInterface _parentFolder
  
  The parent folder. May be a folder or another virtual folder.
- _repository
  
  protected RepositoryInterface _repository
- _searchManager
  
  protected Search _searchManager
- _actionInterfaces
  
  protected Map<String,ProcessorInterface> _actionInterfaces
- _members
  
  protected List<PublicObjectInterface> _members
- _subFolders
  
  protected List<VirtualFolderInterface> _subFolders
- _name
  
  protected String _name
- _id
  
  protected String _id
- _origSearchFilters
  
  protected List<SearchFilter> _origSearchFilters
Method Details
- getIdentifier
  
  public String getIdentifier() throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectInterface
  
  Get the unique ID of this object.
  
  Specified by:
  
  getIdentifier in interface PublicObjectInterface
  
  Overrides:
  
  getIdentifier in class VirtualMetadata
  
  Returns:
  
  String
  
  Throws:
  
  ServiceException
  
  RemoteException
- getReposId
  
  public String getReposId() throws RemoteException
  
  Description copied from interface: MetadataInterface
  
  Get the repository ID for the item. This should be a string that uniquely identifies the object within this repository.
  
  Specified by:
  
  getReposId in interface MetadataInterface
  
  Overrides:
  
  getReposId in class VirtualMetadata
  
  Returns:
  
  The repository identifier for this object.
  
  Throws:
  
  RemoteException - if an error occurs
- refresh
  
  public void refresh() throws ServiceException, RemoteException
  
  Description copied from interface: MetadataInterface
  
  Refresh the data for this object from the repository.
  
  Specified by:
  
  refresh in interface MetadataInterface
  
  Overrides:
  
  refresh in class VirtualMetadata
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getName
  
  public String getName() throws RemoteException
  
  Description copied from interface: PublicObjectInterface
  
  Get the name of this object.
  
  Specified by:
  
  getName in interface PublicObjectInterface
  
  Overrides:
  
  getName in class VirtualMetadata
  
  Returns:
  
  String
  
  Throws:
  
  RemoteException
- getSearchManager
  
  public Search getSearchManager() throws ServiceException, RemoteException
  
  Description copied from interface: VirtualFolderInterface
  
  Returns the search manager that is used to populate the contents of a virtual folder.
  
  Specified by:
  
  getSearchManager in interface VirtualFolderInterface
  
  Returns:
  
  search manager
  
  Throws:
  
  ServiceException
  
  RemoteException
- setSearchManager
  
  public void setSearchManager(Search search) throws ServiceException, RemoteException
  
  Throws:
  
  ServiceException
  
  RemoteException
- getOriginalFilters
  
  protected List<SearchFilter> getOriginalFilters()
- getRepository
  
  public RepositoryInterface getRepository() throws RemoteException
  
  Description copied from interface: MetadataInterface
  
  Get the handle to the repository for this object.
  
  Specified by:
  
  getRepository in interface MetadataInterface
  
  Overrides:
  
  getRepository in class VirtualMetadata
  
  Returns:
  
  A handle to the repository this item exists in.
  
  Throws:
  
  RemoteException - if an error occurs
- setRepository
  
  public void setRepository(RepositoryInterface repository) throws IllegalStateException, RemoteException
  
  Description copied from interface: MetadataInterface
  
  Set the repository that this item exists in.
  
  Specified by:
  
  setRepository in interface MetadataInterface
  
  Overrides:
  
  setRepository in class VirtualMetadata
  
  Parameters:
  
  repository - A handle to the repository for this object.
  
  Throws:
  
  IllegalStateException - If the repository has already been set.
  
  RemoteException - if an error occurs
- getContainer
  
  public PublicObjectContainerInterface getContainer() throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectInterface
  
  Get the object which contains this object.
  
  Specified by:
  
  getContainer in interface PublicObjectInterface
  
  Overrides:
  
  getContainer in class VirtualMetadata
  
  Returns:
  
  PublicObjectContainerInterface
  
  Throws:
  
  ServiceException
  
  RemoteException
- getParent
  
  public FolderInterface getParent() throws ServiceException, RemoteException
  
  Description copied from interface: MetadataInterface
  
  Return the FolderInterface that contains this object. For objects in the SAS Folder hierarchy, there should be exactly one parent folder.
  
  Specified by:
  
  getParent in interface FolderInterface
  
  Specified by:
  
  getParent in interface MetadataInterface
  
  Overrides:
  
  getParent in class VirtualMetadata
  
  Returns:
  
  The FolderInterface that contains this object as a member.
  
  Throws:
  
  ServiceException - if an error occurs
  
  RemoteException - if an error occurs
- getPath
  
  public String getPath() throws RemoteException
  
  Description copied from interface: FolderInterface
  
  Get path of the current folder. This is the path starting with the Tree just below the Bip Service SoftwareComponent down to this folder, with forward-slash separators.
  
  Specified by:
  
  getPath in interface FolderInterface
  
  Returns:
  
  The path string for this folder.
  
  Throws:
  
  RemoteException - in the event of remote object failure.
- getPathUrl
  
  public PathUrl getPathUrl() throws IllegalStateException, ServiceException, RemoteException
  
  Description copied from interface: PublicObjectInterface
  
  Get the SBIP URL. This is an object that contains the repository name, the path from a root to the object, the object's name and the object's type. In the SAS Metadata Server, an object is in a rooted Tree if it has a path to a Tree that's associated to a SoftwareComponent with a ClassIdentifier of "E5F27790-2149-11D6-8828-AA0004006D06", and a name of "BIP Service".
  
  Specified by:
  
  getPathUrl in interface PublicObjectInterface
  
  Overrides:
  
  getPathUrl in class VirtualMetadata
  
  Returns:
  
  a PathUrl value with the object's location in a rooted tree. If the object isn't in a rooted tree, null is returned.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - if a remote object error occurs.
  
  IllegalStateException
- getType
  
  public String getType() throws RemoteException
  
  Description copied from interface: MetadataInterface
  
  Get the object type. Subclasses of Metadata will return a repository-neutral type string. If no subclass exists, Metadata returns the repository-specific type.
  
  Specified by:
  
  getType in interface MetadataInterface
  
  Overrides:
  
  getType in class VirtualMetadata
  
  Returns:
  
  A type string for the object.
  
  Throws:
  
  RemoteException - if an error occurs
- getTypeDescriptor
  
  public TypeDescriptorInterface getTypeDescriptor() throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectInterface
  
  Get the type descriptor which should have the information from the Type Dictionary in metadata available for the clients.
  
  Specified by:
  
  getTypeDescriptor in interface PublicObjectInterface
  
  Overrides:
  
  getTypeDescriptor in class VirtualMetadata
  
  Returns:
  
  TypeDescriptorInterface
  
  Throws:
  
  ServiceException
  
  RemoteException
- getFolderType
  
  public String getFolderType() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get the folder type.
  
  Specified by:
  
  getFolderType in interface FolderInterface
  
  Returns:
  
  A String with the type of folder.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- getProcessorInterface
  
  public ProcessorInterface getProcessorInterface(String interfaceClassName) throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectInterface
  
  Get the specified action interface.
  
  Specified by:
  
  getProcessorInterface in interface PublicObjectInterface
  
  Overrides:
  
  getProcessorInterface in class VirtualMetadata
  
  Parameters:
  
  interfaceClassName -
  
  Returns:
  
  ProcessorInterface
  
  Throws:
  
  ServiceException
  
  RemoteException
- getItem
  
  public MetadataInterface getItem(String name) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get a named item from the folder. With only a name, we can't guarantee that the object coming back will be the one the user wants. Even if we ask for a type, name collisions can occur.
  
  Specified by:
  
  getItem in interface FolderInterface
  
  Parameters:
  
  name - The name of the object to return.
  
  Returns:
  
  A MetadataInterface object matching name.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getPublicTypeItem
  
  public MetadataInterface getPublicTypeItem(String name, String type) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Find an item in this Folder with the given name and type. This will use search to get the item, so it will always go to the server to find the object. The upside is, it will always get a fresh copy of the object. The downside is, no caching applies. This doesn't populate the folders items, and will always go to the server.
  
  Specified by:
  
  getPublicTypeItem in interface FolderInterface
  
  Parameters:
  
  name - The name of the object to find. If null, a null is returned.
  
  type - The public type name of the object type. If this is null, a null is returned. If the type is not recognized as a public type, a ServiceException will be thrown
  
  Returns:
  
  The matching item in this folder, or null if none exists.
  
  Throws:
  
  ServiceException - if the type is not a public type, or if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getItemByClass
  
  public MetadataInterface getItemByClass(String name, Class itemClass) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get a named item from the folder. It must match both the name and the Class provided. If no Class is provided on the call, the first object matching the name is retuned. If no match is found, null is returned.
  
  Specified by:
  
  getItemByClass in interface FolderInterface
  
  Parameters:
  
  name - The name of the object to return.
  
  itemClass - The Class of the object to return.
  
  Returns:
  
  A MetadataInterface object in the folder that matches the name and Class requested.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getItemByType
  
  public MetadataInterface getItemByType(String name, String publicType) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get a named item from the folder. With only a name, we can't guarantee that the object coming back will be the one the user wants. Even if we ask for a type, name collisions can occur.
  
  Specified by:
  
  getItemByType in interface FolderInterface
  
  Parameters:
  
  name - The name of the object to return.
  
  publicType - The type of object to return.
  
  Returns:
  
  A MetadataInterface object that matches the name and type requested, or null if none is found.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getItems
  
  public List<MetadataInterface> getItems() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  List all items in the folder. These are only the individual items. Subfolders will be returned separately.
  
  Specified by:
  
  getItems in interface FolderInterface
  
  Returns:
  
  A List of MetadataInterface objects in this folder.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getItemsByClass
  
  public List<MetadataInterface> getItemsByClass(Class itemClass) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  List the items in the folder that match the Class passed in as a parameter. This Class should be a subclass of MetadataInterface.
  
  Specified by:
  
  getItemsByClass in interface FolderInterface
  
  Parameters:
  
  itemClass - The Class used to filter the folder objects to return.
  
  Returns:
  
  A List of MetadataInterface objects that match the itemClass.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getItemsByType
  
  public List<MetadataInterface> getItemsByType(String metadataType) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get a list of items in the folder of a specific type.
  
  Specified by:
  
  getItemsByType in interface FolderInterface
  
  Parameters:
  
  metadataType - A String that will match the output from the object's getType method.
  
  Returns:
  
  A List of MetadataInterface objects whose getType() method returns the string specified by metadataType.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- addSubfolder
  
  public void addSubfolder(VirtualFolderInterface folder) throws ServiceException, RemoteException
  
  Description copied from interface: VirtualFolderInterface
  
  Adds a nested virtual folder.
  
  Specified by:
  
  addSubfolder in interface VirtualFolderInterface
  
  Parameters:
  
  folder - a sub or nested virtual folder
  
  Throws:
  
  ServiceException
  
  RemoteException
- getSubfolder
  
  public FolderInterface getSubfolder(String name) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get a named subfolder.
  
  Specified by:
  
  getSubfolder in interface FolderInterface
  
  Parameters:
  
  name - The name of the folder to return.
  
  Returns:
  
  A FolderInterface object with the name requested, or null if it doesn't exist.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getSubfolders
  
  public List getSubfolders() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get all the folders immediately below this one in the hiearchy.
  
  Specified by:
  
  getSubfolders in interface FolderInterface
  
  Returns:
  
  A List of FolderInterface objects that are members of this folder.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getTotalNumberOfItems
  
  public int getTotalNumberOfItems() throws RemoteException, ServiceException
  
  Description copied from interface: FolderInterface
  
  Get the total number of items in this folder
  
  Specified by:
  
  getTotalNumberOfItems in interface FolderInterface
  
  Returns:
  
  The number of items in the folder.
  
  Throws:
  
  RemoteException
  
  ServiceException
- hasDuplicate
  
  public boolean hasDuplicate(String name, String type) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Check if there's a duplicate object in this folder with the same name and of the same type.
  
  Specified by:
  
  hasDuplicate in interface FolderInterface
  
  Parameters:
  
  name - The name to check for.
  
  type - The type to check for. This should be the value of the PublicType attribute because I can't necessarily instantiate the object if the current user doesn't have ReadMetadata permission on it. I need to construct a filter to do a getCountNoSecurity with.
  
  Returns:
  
  true if this folder has an object with the given name and type, false otherwise.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- hasDuplicateSubfolder
  
  public boolean hasDuplicateSubfolder(String name) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Check if this folder already has a subfolder with the given name.
  
  Specified by:
  
  hasDuplicateSubfolder in interface FolderInterface
  
  Parameters:
  
  name - The name of the subfolder to check for.
  
  Returns:
  
  true if this folder has a subfolder with the given name, false otherwise.
  
  Throws:
  
  ServiceException - If a metadata server, or other service level error occurs.
  
  RemoteException - In the event of remote object failure.
- isEmpty
  
  public boolean isEmpty() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Returns true if this folder has no subfolders and no member objects. This method may return false even if both FolderInterface.getSubfolders() and FolderInterface.getItems() return empty lists due to objects hidden by access controls.
  
  Specified by:
  
  isEmpty in interface FolderInterface
  
  Returns:
  
  true if this folder has no subfolders and no member objects
  
  Throws:
  
  ServiceException - If a metadata server, or other service level error occurs.
  
  RemoteException - In the event of remote object failure.
- isItemNameUnique
  
  public boolean isItemNameUnique(MetadataInterface member) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Validate that the name of the metadata object is unique within the Folder. The object should already be an item in the folder. If it's not, then the hasDuplicate call should be made. If the member name is unique in the folder, the method returns true. Otherwise it returns false. This method does not validate the name string itself.
  
  Specified by:
  
  isItemNameUnique in interface FolderInterface
  
  Parameters:
  
  member - The item to check for a unique name in the folder.
  
  Returns:
  
  True if the member's name is unique, false otherwise.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- addChild
  
  public void addChild(PublicObjectInterface newChild) throws ServiceException, RemoteException
  
  Description copied from interface: MutableContainerInterface
  
  Add a child to this container. For folders, the new child can be a sub folder, or a simple element.
  
  Specified by:
  
  addChild in interface MutableContainerInterface
  
  Parameters:
  
  newChild - The new child object to add to this container.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- getChildren
  
  public List<PublicObjectInterface> getChildren() throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectContainerInterface
  
  Get a List of the children of this container.
  
  Specified by:
  
  getChildren in interface PublicObjectContainerInterface
  
  Returns:
  
  All child nodes below this container. For folder, this includes subfolders and members.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- getChildCount
  
  public int getChildCount() throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectContainerInterface
  
  Returns the number of children within this container.
  
  Specified by:
  
  getChildCount in interface PublicObjectContainerInterface
  
  Returns:
  
  child count
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- removeChild
  
  public void removeChild(PublicObjectInterface child) throws ServiceException, RemoteException
  
  Description copied from interface: MutableContainerInterface
  
  Remove a child from this container. Trying to remove a child and not moving it to another container may be invalid.
  
  Specified by:
  
  removeChild in interface MutableContainerInterface
  
  Parameters:
  
  child - The child to remove from this container.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- insertChild
  
  public void insertChild(PublicObjectInterface child, int index) throws ServiceException, RemoteException
  
  Description copied from interface: MutableContainerInterface
  
  Inserts a child into the parent container at the specified index.
  
  Specified by:
  
  insertChild in interface MutableContainerInterface
  
  Parameters:
  
  child - the new child to add to this container
  
  index - the index where the child is to be inserted into
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- getChildAt
  
  public PublicObjectInterface getChildAt(int index) throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectContainerInterface
  
  Returns a child item at the specified location
  
  Specified by:
  
  getChildAt in interface PublicObjectContainerInterface
  
  Parameters:
  
  index - the index of the child
  
  Returns:
  
  the child item at the specified index
  
  Throws:
  
  ServiceException
  
  RemoteException
- getChildren
  
  public List getChildren(String type) throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectContainerInterface
  
  Get a list of children of a specific type. The type string should be the unlocalized type, listed as the "Type Abbreviation" in the type dictionary.
  
  Specified by:
  
  getChildren in interface PublicObjectContainerInterface
  
  Parameters:
  
  type - The "type abbreviation" which will be used to filter the children returned from the container.
  
  Returns:
  
  A List of child elements that match the type specified.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- newChild
  
  public PublicObjectInterface newChild(String type, String name) throws ServiceException, RemoteException
  
  Description copied from interface: PublicObjectContainerInterface
  
  Create a new metadata object and add it to the container.
  
  Specified by:
  
  newChild in interface PublicObjectContainerInterface
  
  Parameters:
  
  type - The public object type to add to the container.
  
  name - The name of the new object
  
  Returns:
  
  The newly created public object.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object faiure.
- getItemSublist
  
  public List getItemSublist(int start, int end) throws RemoteException, ServiceException
  
  Description copied from interface: FolderInterface
  
  Get a sublist of items from this folder
  
  Specified by:
  
  getItemSublist in interface FolderInterface
  
  Parameters:
  
  start - item number to start at
  
  end - item number to end at
  
  Returns:
  
  The sublist of items.
  
  Throws:
  
  RemoteException
  
  ServiceException
- getItemSublist
  
  public List getItemSublist(int start, int end, String sort) throws RemoteException, ServiceException
  
  Description copied from interface: FolderInterface
  
  Get a sublist of items from this folder which are sorted.
  
  Specified by:
  
  getItemSublist in interface FolderInterface
  
  Parameters:
  
  start - item number to start at
  
  end - item number to end at
  
  sort - one of name, namedescending, desc, descdescending, date, datedescending, type, typedescending, defaults to name
  
  Returns:
  
  The sorted sublist of items.
  
  Throws:
  
  RemoteException
  
  ServiceException
- makeSubfolder
  
  public FolderInterface makeSubfolder(String name, String type) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Make a subfolder of a specific type. the type string should be the smart object type.
  
  Specified by:
  
  makeSubfolder in interface FolderInterface
  
  Parameters:
  
  name - The name of the new subfolder.
  
  type - The smart object type of the new subfolder.
  
  Returns:
  
  A new subfolder of this folder.
  
  Throws:
  
  ServiceException - If the type is not a FolderInterface derivative, or if a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- makeSubfolder
  
  public FolderInterface makeSubfolder(String name) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Makes a subfolder under the current folder.
  
  Specified by:
  
  makeSubfolder in interface FolderInterface
  
  Parameters:
  
  name - The name of the folder to create.
  
  Returns:
  
  The new folder
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- addItem
  
  public void addItem(MetadataInterface item) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Add an item to the folder. The item should already exist. This method makes the association that puts it in this folder, but doesn't create the item in the store.
  
  Specified by:
  
  addItem in interface FolderInterface
  
  Parameters:
  
  item - The item to add to this folder.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- addNewItem
  
  public MetadataInterface addNewItem(String name, String type) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Create a new metadata object to add to the folder.
  
  Specified by:
  
  addNewItem in interface FolderInterface
  
  Parameters:
  
  name - The name of the new object.
  
  type - The repository-specific type of the new object.
  
  Returns:
  
  The new metadata object.
  
  Throws:
  
  ServiceException - In the event of repository failure.
  
  RemoteException - In the event of remote object failure.
- addSubfolder
  
  public void addSubfolder(FolderInterface folder) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Add an existing folder to this one as a subfolder.
  
  Specified by:
  
  addSubfolder in interface FolderInterface
  
  Parameters:
  
  folder - The folder to add to this one as a subfolder.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- deleteItem
  
  public void deleteItem(MetadataInterface item) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Delete an item from this folder. This method deletes the item from the repository as well as removing it from the folder.
  
  Specified by:
  
  deleteItem in interface FolderInterface
  
  Parameters:
  
  item - The item to delete from this folder.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- deleteSubfolder
  
  public void deleteSubfolder(String name) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Delete a subfolder. This will only work if the folder is empty.
  
  Specified by:
  
  deleteSubfolder in interface FolderInterface
  
  Parameters:
  
  name - The name of the subfolder to delete.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- getContentCreateDate
  
  public Date getContentCreateDate() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get the content create date. This is maintained separately from the metadata create date, which is when the Tree object itself was created. This date indicates when the content folder was created.
  
  Specified by:
  
  getContentCreateDate in interface FolderInterface
  
  Returns:
  
  The Date when the content folder was created.
  
  Throws:
  
  ServiceException - If a service level error occured.
  
  RemoteException - In the event of remote object failure.
- getContentInfo
  
  public ContentInfo getContentInfo() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Returns the ContentInfoobject corresponding to the root of the given PathUrl.
  Implementation Note: computed results are cached; repeated calls are not expensive.
  
  Specified by:
  
  getContentInfo in interface FolderInterface
  
  Returns:
  
  The ContentInfo object with the path and credentials for the content area, or null if the folder isn't content mapped.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- getContentModifyDate
  
  public Date getContentModifyDate() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Get the content modification date. This is the date and time of the most recent addition to or deletion from this folder. This information may be maintained by the client.
  
  Specified by:
  
  getContentModifyDate in interface FolderInterface
  
  Returns:
  
  The Date when an object was last added or removed.
  
  Throws:
  
  ServiceException - If a service level error occured.
  
  RemoteException - In the event of remote object failure.
- moveMembersOnOverflow
  
  public boolean moveMembersOnOverflow() throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Check for too many objects in a folder. If the folder contains more than a limit defined by the folder, the current members of the folder are moved to a new subfolder. The new subfolder will be named "1", "2", etc. Subfolders are not considered in the count.
  
  Specified by:
  
  moveMembersOnOverflow in interface FolderInterface
  
  Returns:
  
  true if objects were moved to a subfolder
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.
- removeItem
  
  public void removeItem(MetadataInterface item) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Remove an item from the folder. This call just breaks the association with the item, and leaves it otherwise undisturbed in the repository.
  
  Specified by:
  
  removeItem in interface FolderInterface
  
  Parameters:
  
  item - The item to remove from this folder.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- removeSubfolder
  
  public void removeSubfolder(String name) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Remove a subfolder from the current folder. This breaks the association, but does not remove it from the repository.
  
  Specified by:
  
  removeSubfolder in interface FolderInterface
  
  Parameters:
  
  name - The name of the subfolder to remove.
  
  Throws:
  
  ServiceException - if a repository error occurs.
  
  RemoteException - in the event of remote object failure.
- setContentCreateDate
  
  public void setContentCreateDate(Date date) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Set the Date that the content folder was created.
  
  Specified by:
  
  setContentCreateDate in interface FolderInterface
  
  Parameters:
  
  date - The date that the mapped content folder was created.
  
  Throws:
  
  ServiceException - If a service level error occured.
  
  RemoteException - In the event of remote object failure.
- setContentModifyDate
  
  public void setContentModifyDate(Date date) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Set the date when an object was last added to or removed from this folder.
  
  Specified by:
  
  setContentModifyDate in interface FolderInterface
  
  Parameters:
  
  date - The last time the contents of this folder were modified.
  
  Throws:
  
  ServiceException - If a service level error occured.
  
  RemoteException - In the event of remote object failure.
- setFolderType
  
  public void setFolderType(String type) throws ServiceException, RemoteException
  
  Description copied from interface: FolderInterface
  
  Set the folder type.
  
  Specified by:
  
  setFolderType in interface FolderInterface
  
  Parameters:
  
  type - The String indicating the type of the folder.
  
  Throws:
  
  ServiceException - If a repository error occurs.
  
  RemoteException - In the event of remote object failure.

*** This class provides Binary Compatibility only, not Source Compatibility ***

Class VirtualFolder

Field Summary

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

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

Method Summary

Methods inherited from class com.sas.services.information.metadata.VirtualMetadata

Methods inherited from class java.lang.Object

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

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

Field Details

_parentFolder

_repository

_searchManager

_actionInterfaces

_members

_subFolders

_name

_id

_origSearchFilters

Method Details

getIdentifier

getReposId

refresh

getName

getSearchManager

setSearchManager

getOriginalFilters

getRepository

setRepository

getContainer

getParent

getPath

getPathUrl

getType

getTypeDescriptor

getFolderType

getProcessorInterface

getItem

getPublicTypeItem

getItemByClass

getItemByType

getItems

getItemsByClass

getItemsByType

addSubfolder

getSubfolder

getSubfolders

getTotalNumberOfItems

hasDuplicate

hasDuplicateSubfolder

isEmpty

isItemNameUnique

addChild

getChildren

getChildCount

toString

removeChild

insertChild

getChildAt

getChildren

newChild

getItemSublist

getItemSublist

makeSubfolder

makeSubfolder

addItem

addNewItem

addSubfolder

deleteItem

deleteSubfolder

getContentCreateDate

getContentInfo

getContentModifyDate

moveMembersOnOverflow

removeItem

removeSubfolder

setContentCreateDate

setContentModifyDate

setFolderType

* This class provides Binary Compatibility only, not Source Compatibility *