org.unitedinternet.cosmo.model

Interface Item

All Superinterfaces:

AuditableObject

All Known Subinterfaces:

AvailabilityItem, CollectionItem, ContentItem, FileItem, FreeBusyItem, HomeCollectionItem, ICalendarItem, NoteItem, NoteOccurrence

public interface Item
extends AuditableObject

Represents an item on server. All content in cosmo extends from Item.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(Attribute attribute)
void	addStamp(Stamp stamp) Add stamp to Item
void	addTicket(Ticket ticket)
Item	copy()
Attribute	getAttribute(QName qname) Get attribute with qualified name.
Attribute	getAttribute(String name) Get attribute in default namespace with local name.
Map<QName,Attribute>	getAttributes() Get all Attributes of Item.
Map<String,Attribute>	getAttributes(String namespace) Return Attributes for a given namespace.
Object	getAttributeValue(QName qname) Get attribute value with qualified name
Object	getAttributeValue(String name) Get attribute value with local name in default namespace
Date	getClientCreationDate()
Date	getClientModifiedDate()
String	getDisplayName()
Boolean	getIsActive() Transient attribute used to mark item for deletion.
String	getName()
User	getOwner()
CollectionItem	getParent() Gets the parent of this item.
CollectionItemDetails	getParentDetails(CollectionItem parent) Each collection an item belongs to contains additional attributes, and is represented as a CollectionItemDetails object.
Set<CollectionItem>	getParents()
Stamp	getStamp(Class<?> clazz) Get the stamp that corresponds to the specified class
Stamp	getStamp(String type) Get the stamp that corresponds to the specified type
Map<String,Stamp>	getStampMap()
Set<Stamp>	getStamps() Return all stamps associated with Item.
Set<Ticket>	getTickets() Get all Tickets on Item.
Set<Tombstone>	getTombstones()
String	getUid()
void	removeAttribute(QName qname) Remove attribute.
void	removeAttribute(String name) Remove attribute in default namespace with local name.
void	removeAttributes(String namespace) Remove all attributes in a namespace.
void	removeStamp(Stamp stamp) Remove stamp from Item.
void	removeTicket(Ticket ticket)
void	setAttribute(QName key, Object value) Set attribute value attribute with qualified name
void	setAttribute(String name, Object value) Set attribute value of attribute with local name in default namespace.
void	setClientCreationDate(Date clientCreationDate)
void	setClientModifiedDate(Date clientModifiedDate)
void	setDisplayName(String displayName)
void	setIsActive(Boolean isActive) Transient attribute used to mark item for deletion.
void	setName(String name)
void	setOwner(User owner)
void	setUid(String uid)

Methods inherited from interface org.unitedinternet.cosmo.model.AuditableObject

getCreationDate, getEntityTag, getFactory, getModifiedDate, updateTimestamp

Method Detail

getStamps

Set<Stamp> getStamps()

Return all stamps associated with Item. Use addStamp() and removeStamp() to manipulate set.

Returns:

set of stamps associated with Item

getStampMap

Map<String,Stamp> getStampMap()

Returns:

Map of Stamps indexed by Stamp type.

addStamp

void addStamp(Stamp stamp)

Add stamp to Item

Parameters:

stamp - stamp to add

removeStamp

void removeStamp(Stamp stamp)

Remove stamp from Item.

Parameters:

stamp - stamp to remove

getStamp

Stamp getStamp(String type)

Get the stamp that corresponds to the specified type

Parameters:

type - stamp type to return

Returns:

stamp

getStamp

Stamp getStamp(Class<?> clazz)

Get the stamp that corresponds to the specified class

Parameters:

clazz - class of stamp to return

Returns:

stamp

getAttributes

Map<QName,Attribute> getAttributes()

Get all Attributes of Item. Use addAttribute() and removeAttribute() to manipulate map.

Returns:

addTicket

void addTicket(Ticket ticket)

removeTicket

void removeTicket(Ticket ticket)

addAttribute

void addAttribute(Attribute attribute)

removeAttribute

void removeAttribute(String name)

Remove attribute in default namespace with local name.

Parameters:

name - local name of attribute to remove

removeAttribute

void removeAttribute(QName qname)

Remove attribute.

Parameters:

qname - qualifed name of attribute to remove.

removeAttributes

void removeAttributes(String namespace)

Remove all attributes in a namespace.

Parameters:

namespace - namespace of attributes to remove

getAttribute

Attribute getAttribute(String name)

Get attribute in default namespace with local name.

Parameters:

name - local name of attribute

Returns:

attribute in default namespace with given name

getAttribute

Attribute getAttribute(QName qname)

Get attribute with qualified name.

Parameters:

qname - qualified name of attribute to retrieve

Returns:

attribute with qualified name.

getAttributeValue

Object getAttributeValue(String name)

Get attribute value with local name in default namespace

Parameters:

name - local name of attribute

Returns:

attribute value

getAttributeValue

Object getAttributeValue(QName qname)

Get attribute value with qualified name

Parameters:

qname - qualified name of attribute

Returns:

attribute value

setAttribute

void setAttribute(String name,
                  Object value)

Set attribute value of attribute with local name in default namespace.

Parameters:

name - local name of attribute

value - value to update attribute

setAttribute

void setAttribute(QName key,
                  Object value)

Set attribute value attribute with qualified name

Parameters:

key - qualified name of attribute

value - value to update attribute

getAttributes

Map<String,Attribute> getAttributes(String namespace)

Return Attributes for a given namespace. Attributes are returned in a Map indexed by the name of the attribute.

Parameters:

namespace - namespace of the Attributes to return

Returns:

map of Attributes indexed by the name of the attribute

getClientCreationDate

Date getClientCreationDate()

setClientCreationDate

void setClientCreationDate(Date clientCreationDate)

getClientModifiedDate

Date getClientModifiedDate()

setClientModifiedDate

void setClientModifiedDate(Date clientModifiedDate)

getName

String getName()

setName

void setName(String name)

getDisplayName

String getDisplayName()

Returns:

Item's human readable name

setDisplayName

void setDisplayName(String displayName)

Parameters:

displayName - Item's human readable name

getOwner

User getOwner()

setOwner

void setOwner(User owner)

getUid

String getUid()

setUid

void setUid(String uid)

getParents

Set<CollectionItem> getParents()

getParentDetails

CollectionItemDetails getParentDetails(CollectionItem parent)

Each collection an item belongs to contains additional attributes, and is represented as a CollectionItemDetails object.

Parameters:

parent - parent collection

Returns:

details about parent<-->child relationship

getParent

CollectionItem getParent()

Gets the parent of this item. Note that usually there is only one parent.

getIsActive

Boolean getIsActive()

Transient attribute used to mark item for deletion.

Returns:

true if item should be deleted

setIsActive

void setIsActive(Boolean isActive)

Transient attribute used to mark item for deletion.

Parameters:

isActive - true if item should be deleted

getTickets

Set<Ticket> getTickets()

Get all Tickets on Item.

Returns:

set of tickets

getTombstones

Set<Tombstone> getTombstones()

copy

Item copy()