com.crystaldecisions.sdk.occa.infostore
Interface IContainer

All Superinterfaces:

IInfoObject

All Known Subinterfaces:

ICategory, IFolder

public interface IContainer
extends IInfoObject

Nested Class Summary

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObject

IInfoObject.CommitLevel, IInfoObject.Delta, IInfoObject.LocaleOption, IInfoObject.LockStatus, IInfoObject.PropertySet

Method Summary

IInfoObject	add(java.lang.String kind) Adds an object into the collection
IInfoObjects	getChildren() Returns all the objects in this container.
IInfoObjects	getChildren(int propertySet, SearchPattern searchPattern, SortType sortType) Returns the objects in this container.
IInfoObjects	getContents() Returns all the objects that are not containers
IInfoObjects	getContents(int propertySet, SearchPattern searchPattern, SortType sortType) Returns the objects that are not containers.

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObject

applyDelta, applyDelta, clearTenantID, deleteNow, getCommitLevel, getCUID, getDelta, getDelta, getDescription, getDescription, getDescription, getDescriptionLocales, getFileLocales, getFiles, getFiles, getGUID, getID, getKeyword, getKind, getLockInfo, getOwner, getOwnerID, getParent, getParent, getParentCUID, getParentID, getProcessingInfo, getProgID, getRUID, getSchedulingInfo, getSecurityInfo, getSecurityInfo2, getSourceFiles, getSpecificKind, getSpecificProgID, getTenantID, getTitle, getTitle, getTitle, getTitleLocales, getUpdateTimeStamp, isDirty, isInstance, isLockHeld, isMarkedAsRead, isReadOnly, properties, propertyIDs, releaseLock, removeFiles, removeSourceFiles, retrievePropertySet, save, setCommitLevel, setDescription, setKeyword, setMarkedAsRead, setParentID, setTenantID, setTitle, unlockNow

Method Detail

getChildren

IInfoObjects getChildren()
                         throws SDKException

Returns all the objects in this container.

Returns:

Retrieves a list IInfoObjects in the container.

Throws:

SDKException - This exception is thrown if the objects cannot be retrieved.

getChildren

IInfoObjects getChildren(int propertySet,
                         SearchPattern searchPattern,
                         SortType sortType)
                         throws SDKException

Returns the objects in this container.

Parameters:

propertySet - The IInfoObject.propertySet to get from the repository.

searchPattern - The SearchPattern to use to find an object.

sortType - The SortType to sort the list of objects retrieved from the repository.

Returns:

The IInfoObjects collection.

Throws:

SDKException

getContents

IInfoObjects getContents()
                         throws SDKException

Returns all the objects that are not containers

Returns:

Retrieves a list of the content IInfoObjects in the container.

Throws:

SDKException - This exception is thrown if the objects cannot be retrieved.

getContents

IInfoObjects getContents(int propertySet,
                         SearchPattern searchPattern,
                         SortType sortType)
                         throws SDKException

Returns the objects that are not containers.

Parameters:

propertySet - The IInfoObject.propertySet to get from the repository.

searchPattern - The SearchPattern to use to find an object.

sortType - The SortType to sort the list of objects retrieved from the repository.

Returns:

The IInfoObjects collection.

Throws:

SDKException

add

IInfoObject add(java.lang.String kind)
                throws SDKException

Adds an object into the collection

Parameters:

kind - The kind of the object you want to add

Returns:

The newly created InfoObject as an IInfoObject.

Throws:

SDKException - This exception is thrown if the process is unsuccessful.