com.fatwire.agent
Interface IRepository


public interface IRepository

Content repository interface.

A repository is top-level container of items. It is used as a synchronization point - the synchronization is performed between two repositories. This class is used a base to all repository implementations. Every repository has a top folder - the root of its folders tree.


Method Summary
 IItem getItemByID(java.lang.String versionid)
          Retrieves item by its unique version identifier.
 IItem getItemByPath(Path path)
          Gets item by its path.
 java.lang.String getName()
          Gets repository name.
 java.lang.String getRepositoryID()
          Retrieves repository unique identifier.
 RepositoryInfo getRepositoryInfo()
          Retrieves repository information block.
 IItem getTopFolder()
          Retrieves repository top folder.
 

Method Detail

getRepositoryInfo

RepositoryInfo getRepositoryInfo()
Retrieves repository information block.

Returns:
repository information block

getRepositoryID

java.lang.String getRepositoryID()
Retrieves repository unique identifier.

Returns:
repository id.

getName

java.lang.String getName()
Gets repository name.

Returns:
repository name.

getTopFolder

IItem getTopFolder()
                   throws AgentException
Retrieves repository top folder.

Returns:
repository top folder.
Throws:
AgentException - if the top folder could not be retrieved.

getItemByID

IItem getItemByID(java.lang.String versionid)
                  throws NotFoundException,
                         AgentException
Retrieves item by its unique version identifier.

Parameters:
versionid - item version identifier.
Returns:
requested item.
Throws:
NotFoundException - if item wasn't found.
AgentException - if an error occured during the retrieval operation.

getItemByPath

IItem getItemByPath(Path path)
                    throws AgentException
Gets item by its path. Path is a list of item's parents starting from the top folder.

Parameters:
path - item's path.
Throws:
NotFoundException - if item wasn't found.
AgentException - if an error occured during the retrieval operation.