org.apache.chemistry.opencmis.inmemory.storedobj.api

Interface ObjectStoreFiling

All Known Subinterfaces:

ObjectStoreMultiFiling, ObjectStoreSingleFiling

All Known Implementing Classes:

ObjectStoreImpl

public interface ObjectStoreFiling

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectStoreFiling.ChildrenResult

Method Summary

Methods

Modifier and Type	Method and Description
ObjectStoreFiling.ChildrenResult	getChildren(Folder folder, int maxItems, int skipCount, String user, boolean usePwc) get all the children of this folder.
ObjectStoreFiling.ChildrenResult	getFolderChildren(Folder folder, int maxItems, int skipCount, String user) get all the children of this folder which are folders.
List<String>	getParentIds(Filing spo, String user) get all parent ids of this object visible for a user
void	move(StoredObject so, Folder oldParent, Folder newParent) Move an object to a different folder.
void	rename(Fileable so, String newName) Rename an object

Method Detail

getChildren

ObjectStoreFiling.ChildrenResult getChildren(Folder folder,
                                           int maxItems,
                                           int skipCount,
                                           String user,
                                           boolean usePwc)

get all the children of this folder. To support paging an initial offset and a maximum number of children to retrieve can be passed

Parameters:

folder - folder to get children from

maxItems - max. number of items to return

skipCount - initial offset where to start fetching

user - user to determine visible children

usePwc - if true return private working copy otherwise return latest version;

Returns:

list of children objects

getFolderChildren

ObjectStoreFiling.ChildrenResult getFolderChildren(Folder folder,
                                                 int maxItems,
                                                 int skipCount,
                                                 String user)

get all the children of this folder which are folders. To support paging an initial offset and a maximum number of children to retrieve can be passed.

Parameters:

folder - folder to get children from

maxItems - max. number of items to return

skipCount - initial offset where to start fetching

user -

Returns:

list of children folders

getParentIds

List<String> getParentIds(Filing spo,
                        String user)

get all parent ids of this object visible for a user

Parameters:

user - user who can see parents

Returns:

list of folder ids

move

void move(StoredObject so,
        Folder oldParent,
        Folder newParent)

Move an object to a different folder.

Parameters:

so - object to be moved

oldParent - old parent folder for the object

newParent - new parent folder for the object

rename

void rename(Fileable so,
          String newName)

Rename an object

Parameters:

so - object to be renamed

newName - new name to be assigned