|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IItem
Represents an individual asset or folder in a repository.
This is actually a smallest individual part in a repository. For example, for filesystem an item could be either a directory or a file. An item can have primary contents (retrieved via getInputStream() call) and metadata. Metadata consists of; 1. Dublin Core properties: name, title, createtion/modification dates, MIME type, author, keywords, summary, description 2. Binary data: frames, proxies, tokens 3. Custom properties Custom properties conform a user-defined schema which consists of asset types with various fields - descriptors. Thus car.jpg and apple.png file system items can be of Image asset type with Width and Height descriptors. Each item has a unique identifier inside a repository called item id. If an item is versioned than it has different version ids assigned, otherwise item id and version id are equal. Items are organized in a tree-like hierarchy maintained by folders. Each item also has a name which is unique inside the folder where it resides. Each repository has a single top folder which is a root of the tree hierarchy.
IRepository
Method Summary | |
---|---|
void |
addAssetTypeUID(java.lang.String uid)
Adds asset type unique identifier to this item. |
java.util.List<java.lang.String> |
getAssetTypeUIDs()
Retrieves the list of all asset types supported by this item. |
java.lang.String |
getAuthor()
Gets the author of this item. |
java.util.Date |
getDateCreated()
Gets the date when this item was created. |
java.util.Date |
getDateModified()
Gets the date when this item was modified. |
java.lang.String |
getDescription()
Gets item's description. |
java.lang.String |
getFilename()
Retrieves file name associated with this item if any. |
java.io.InputStream |
getInputStream()
Retrieves the input stream to the primary contents of this item. |
java.util.List<ItemFrame> |
getItemFrames()
Gets the list of item frames. |
java.lang.String |
getItemID()
Gets item identifier. |
ItemProxy |
getItemProxy(ProxyType type)
Gets the requested item proxy. |
ItemTokens |
getItemTokens()
Gets item tokens. |
java.lang.String |
getKeywords()
Gets item's keywords. |
long |
getLength()
Returns length in bytes of item's primary contents. |
java.lang.String |
getMajortype()
Gets the major component of item's MIME type, e.g. |
java.lang.String |
getMinortype()
Gets the minor component of item's MIME type, e.g. |
java.lang.String |
getName()
Get item name. |
IItem |
getParent()
Gets parent folder item. |
java.lang.String |
getParentID()
Parent folder version identifier. |
java.util.List<IItem> |
getParents()
Retrieves the list of parent folders starting from the root. |
Path |
getPath()
Gets item path. |
Properties |
getProperties()
Gets all properties of this item. |
java.lang.String |
getSummary()
Gets item's summary. |
java.lang.String |
getTitle()
Gets item's title. |
java.lang.String |
getVersionID()
Gets item version identifier. |
java.lang.String |
getVersionNumber()
Gets item version number. |
boolean |
isFolder()
Returns 'true' if this item is a container (folder) or an asset. |
java.util.List<IItem> |
search(Query query)
Performs a search within this item for the specified depth filtering by keywords, item types, and limiting the properties returned. |
void |
setAuthor(java.lang.String author)
Sets the author of this item. |
void |
setDescription(java.lang.String description)
Sets item's description. |
void |
setFilename(java.lang.String fileName)
Sets file name associated with this item. |
void |
setItemFrames(java.util.List<ItemFrame> frames)
Sets item frames. |
void |
setItemProxy(ItemProxy proxy,
ProxyType type)
Sets item proxy. |
void |
setItemTokens(ItemTokens tokens)
Sets item tokens. |
void |
setKeywords(java.lang.String keywords)
Sets item's keywords. |
void |
setSummary(java.lang.String summary)
Sets item's summary. |
void |
setTitle(java.lang.String title)
Sets item's title. |
Method Detail |
---|
java.lang.String getItemID()
java.lang.String getVersionID()
java.lang.String getVersionNumber()
java.lang.String getParentID()
java.lang.String getName()
Path getPath()
boolean isFolder()
long getLength()
IItem getParent() throws AgentException
AgentException
- if an error happens during the parent item fetching process.java.util.List<IItem> getParents() throws AgentException
AgentException
- if an error happens during the parent items fetching process.java.util.List<IItem> search(Query query) throws AgentException
query
- query to run.
AgentException
- if an error occurs which prevents items to be retrievedjava.io.InputStream getInputStream() throws NotFoundException, FeatureNotSupportedException, AgentException
NotFoundException
- if this item doesn't exist any more.
FeatureNotSupportedException
- if this item doesn't have contents.
AgentException
- if an error occurs.java.util.Date getDateCreated()
java.util.Date getDateModified()
java.lang.String getMajortype()
java.lang.String getMinortype()
java.lang.String getTitle()
void setTitle(java.lang.String title)
title
- title to set.java.lang.String getAuthor()
void setAuthor(java.lang.String author)
author
- author to set.java.lang.String getKeywords()
void setKeywords(java.lang.String keywords)
keywords
- keywords to set.java.lang.String getSummary()
void setSummary(java.lang.String summary)
summary
- summary to set.java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- description to set.java.util.List<java.lang.String> getAssetTypeUIDs()
void addAssetTypeUID(java.lang.String uid)
uid
- asset type to add.Properties getProperties()
ItemTokens getItemTokens()
void setItemTokens(ItemTokens tokens)
tokens
- tokens to set.java.util.List<ItemFrame> getItemFrames()
void setItemFrames(java.util.List<ItemFrame> frames)
frames
- frames to set.ItemProxy getItemProxy(ProxyType type)
type
- type of the proxy to retrieve.
void setItemProxy(ItemProxy proxy, ProxyType type)
proxy
- proxy to set.type
- proxy type.java.lang.String getFilename()
void setFilename(java.lang.String fileName)
fileName
- file name.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |