magoffin.matt.ma2.domain
Interface MediaItem

All Known Subinterfaces:

MediaItemSearchResult

public interface MediaItem

Java content class for media-item complex type.

The following schema fragment specifies the expected content contained within this java content object. (defined at file:/Volumes/Renton/Users/matt/ws/ws-home/matte/hyperjaxb2-build/src/main/resources/domain.xsd line 104)

 <complexType name="media-item">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="tz" type="{http://msqr.us/xsd/matte}time-zone"/>
         <element name="tz-display" type="{http://msqr.us/xsd/matte}time-zone" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="media-type" type="{http://msqr.us/xsd/matte}media-item-type" minOccurs="0"/>
         <element name="metadata" type="{http://msqr.us/xsd/matte}metadata" maxOccurs="unbounded" minOccurs="0"/>
         <element name="user-rating" type="{http://msqr.us/xsd/matte}media-item-rating" maxOccurs="unbounded" minOccurs="0"/>
         <element name="user-comment" type="{http://msqr.us/xsd/matte}user-comment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="user-tag" type="{http://msqr.us/xsd/matte}user-tag" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="creation-date" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="display-order" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="file-size" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="height" use="required" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="hits" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="item-date" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="item-id" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="mime" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="modify-date" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="use-icon" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="width" use="required" type="{http://www.w3.org/2001/XMLSchema}int" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

java.util.Calendar	getCreationDate() Gets the value of the creationDate property.
java.lang.String	getDescription() Gets the value of the description property.
int	getDisplayOrder() Gets the value of the displayOrder property.
java.lang.Long	getFileSize() Gets the value of the fileSize property.
int	getHeight() Gets the value of the height property.
int	getHits() Gets the value of the hits property.
java.util.Calendar	getItemDate() Gets the value of the itemDate property.
java.lang.Long	getItemId() Gets the value of the itemId property.
MediaItemType	getMediaType() The type of media this item represents, e.g.
java.util.List	getMetadata() Gets the value of the Metadata property.
java.lang.String	getMime() Gets the value of the mime property.
java.util.Calendar	getModifyDate() Gets the value of the modifyDate property.
java.lang.String	getName() Gets the value of the name property.
java.lang.String	getPath() Gets the value of the path property.
TimeZone	getTz() The time zone of the creation date.
TimeZone	getTzDisplay() The time zone to display the creation date as.
java.util.List	getUserComment() Gets the value of the UserComment property.
java.util.List	getUserRating() Gets the value of the UserRating property.
java.util.List	getUserTag() Gets the value of the UserTag property.
int	getWidth() Gets the value of the width property.
boolean	isUseIcon() Gets the value of the useIcon property.
void	setCreationDate(java.util.Calendar value) Sets the value of the creationDate property.
void	setDescription(java.lang.String value) Sets the value of the description property.
void	setDisplayOrder(int value) Sets the value of the displayOrder property.
void	setFileSize(java.lang.Long value) Sets the value of the fileSize property.
void	setHeight(int value) Sets the value of the height property.
void	setHits(int value) Sets the value of the hits property.
void	setItemDate(java.util.Calendar value) Sets the value of the itemDate property.
void	setItemId(java.lang.Long value) Sets the value of the itemId property.
void	setMediaType(MediaItemType value) The type of media this item represents, e.g.
void	setMime(java.lang.String value) Sets the value of the mime property.
void	setModifyDate(java.util.Calendar value) Sets the value of the modifyDate property.
void	setName(java.lang.String value) Sets the value of the name property.
void	setPath(java.lang.String value) Sets the value of the path property.
void	setTz(TimeZone value) The time zone of the creation date.
void	setTzDisplay(TimeZone value) The time zone to display the creation date as.
void	setUseIcon(boolean value) Sets the value of the useIcon property.
void	setWidth(int value) Sets the value of the width property.

Method Detail

getHits

int getHits()

Gets the value of the hits property.

setHits

void setHits(int value)

Sets the value of the hits property.

getHeight

int getHeight()

Gets the value of the height property.

setHeight

void setHeight(int value)

Sets the value of the height property.

getUserComment

java.util.List getUserComment()

Gets the value of the UserComment property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the UserComment property.

For example, to add a new item, do as follows:

    getUserComment().add(newItem);
 

Objects of the following type(s) are allowed in the list UserComment

getUserRating

java.util.List getUserRating()

Gets the value of the UserRating property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the UserRating property.

For example, to add a new item, do as follows:

    getUserRating().add(newItem);
 

Objects of the following type(s) are allowed in the list MediaItemRating

getTzDisplay

TimeZone getTzDisplay()

The time zone to display the creation date as.

Returns:

possible object is TimeZone

setTzDisplay

void setTzDisplay(TimeZone value)

The time zone to display the creation date as.

Parameters:

value - allowed object is TimeZone

getItemId

java.lang.Long getItemId()

Gets the value of the itemId property.

Returns:

possible object is Long

setItemId

void setItemId(java.lang.Long value)

Sets the value of the itemId property.

Parameters:

value - allowed object is Long

getMediaType

MediaItemType getMediaType()

The type of media this item represents, e.g. photo, album, movie, book, etc.

Returns:

possible object is MediaItemType

setMediaType

void setMediaType(MediaItemType value)

The type of media this item represents, e.g. photo, album, movie, book, etc.

Parameters:

value - allowed object is MediaItemType

getDescription

java.lang.String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

void setDescription(java.lang.String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getTz

TimeZone getTz()

The time zone of the creation date.

Returns:

possible object is TimeZone

setTz

void setTz(TimeZone value)

The time zone of the creation date.

Parameters:

value - allowed object is TimeZone

getWidth

int getWidth()

Gets the value of the width property.

setWidth

void setWidth(int value)

Sets the value of the width property.

getUserTag

java.util.List getUserTag()

Gets the value of the UserTag property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the UserTag property.

For example, to add a new item, do as follows:

    getUserTag().add(newItem);
 

Objects of the following type(s) are allowed in the list UserTag

getPath

java.lang.String getPath()

Gets the value of the path property.

Returns:

possible object is String

setPath

void setPath(java.lang.String value)

Sets the value of the path property.

Parameters:

value - allowed object is String

getMime

java.lang.String getMime()

Gets the value of the mime property.

Returns:

possible object is String

setMime

void setMime(java.lang.String value)

Sets the value of the mime property.

Parameters:

value - allowed object is String

getDisplayOrder

int getDisplayOrder()

Gets the value of the displayOrder property.

setDisplayOrder

void setDisplayOrder(int value)

Sets the value of the displayOrder property.

getName

java.lang.String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

void setName(java.lang.String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

isUseIcon

boolean isUseIcon()

Gets the value of the useIcon property.

setUseIcon

void setUseIcon(boolean value)

Sets the value of the useIcon property.

getModifyDate

java.util.Calendar getModifyDate()

Gets the value of the modifyDate property.

Returns:

possible object is Calendar

setModifyDate

void setModifyDate(java.util.Calendar value)

Sets the value of the modifyDate property.

Parameters:

value - allowed object is Calendar

getMetadata

java.util.List getMetadata()

Gets the value of the Metadata property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the Metadata property.

For example, to add a new item, do as follows:

    getMetadata().add(newItem);
 

Objects of the following type(s) are allowed in the list Metadata

getCreationDate

java.util.Calendar getCreationDate()

Gets the value of the creationDate property.

Returns:

possible object is Calendar

setCreationDate

void setCreationDate(java.util.Calendar value)

Sets the value of the creationDate property.

Parameters:

value - allowed object is Calendar

getFileSize

java.lang.Long getFileSize()

Gets the value of the fileSize property.

Returns:

possible object is Long

setFileSize

void setFileSize(java.lang.Long value)

Sets the value of the fileSize property.

Parameters:

value - allowed object is Long

getItemDate

java.util.Calendar getItemDate()

Gets the value of the itemDate property.

Returns:

possible object is Calendar

setItemDate

void setItemDate(java.util.Calendar value)

Sets the value of the itemDate property.

Parameters:

value - allowed object is Calendar