nl.gx.webmanager.cms.mediarepository
Interface MediaItemFilter

public interface MediaItemFilter

Represents the media item filter. Filter can be used for searching media items.

Nested Class Summary

static class

MediaItemFilter.OperationType Filter operation type.

Method Summary

MediaContentType[]	getContentType() Returns the filter content type.
int	getCreatedSince() Returns the filter created since days parameter.
MediaItem[]	getExcludeMediaItems() Returns the filter exclude media items parameter.
java.util.Date	getExpirationDateFrom() Returns the filter expiration date to parameter.
java.util.Date	getExpirationDateTo() Returns the filter expiration date to parameter.
java.lang.String	getExternalId() Returns the filter external id parameter.
java.util.Date	getPublicationDateFrom() Returns the filter publication date from parameter.
java.util.Date	getPublicationDateTo() Returns the filter publication date to parameter.
MediaItem	getReferencedMediaItem() Returns the filter referenced media item.
ResourceInstance	getReferencedResourceInstance() Returns the filter referenced database resource instance
int	getResultFrom() Returns the filter from range parameter.
int	getResultTo() Returns the filter to range parameter.
WorkflowModelState[]	getStatus() Return the filter state.
MediaTerm[]	getTerms(MediaItemFilter.OperationType type) Returns the filter media terms for the given operation type.
java.lang.String	getTitle() Returns the title.
void	setContentType(MediaContentType[] type) Sets the filter content type.
void	setCreatedSince(int days) Sets the filter created since days parameter.
void	setExcludeMediaItems(MediaItem[] mediaItems) Set the filter exclude media items parameter.
void	setExpirationDateFrom(java.util.Date fromDate) Sets the filter expiration fromdate from parameter.
void	setExpirationDateTo(java.util.Date toDate) Sets the filter expiration todate from parameter.
void	setExternalId(java.lang.String externalId) Sets the filter external id parameter.
void	setPublicationDateFrom(java.util.Date fromDate) Sets the filter publication date from parameter.
void	setPublicationDateTo(java.util.Date toDate) Sets the filter publication date to parameter.
void	setReferencedMediaItem(MediaItem mediaItem) Sets the filter referenced media item.
void	setReferencedResourceInstance(ResourceInstance resourceInstance) Set the referenced database resource instance
void	setResultRange(int from, int to) Sets the filter result range parameter.
void	setStatus(WorkflowModelState[] states) Sets the filter state.
void	setTerms(MediaTerm[] terms, MediaItemFilter.OperationType type) Sets the filter terms for the given operation type.
void	setTitle(java.lang.String webtitle) Sets the filter title.

Method Detail

getTitle

java.lang.String getTitle()

Returns the title.

Returns:

the title

setTitle

void setTitle(java.lang.String webtitle)

Sets the filter title. This may include the following wildcards:

• '_' A substitute for exactly one character.
• '%' A substitute for zero or more characters.

Parameters:

type - the title to set

getContentType

MediaContentType[] getContentType()

Returns the filter content type.

Returns:

the content type

setContentType

void setContentType(MediaContentType[] type)

Sets the filter content type.

Parameters:

type - the content type to set

getTerms

MediaTerm[] getTerms(MediaItemFilter.OperationType type)

Returns the filter media terms for the given operation type.

Parameters:

type - the operation type

Returns:

the media terms

setTerms

void setTerms(MediaTerm[] terms,
              MediaItemFilter.OperationType type)

Sets the filter terms for the given operation type.

Parameters:

terms - the media item terms to set

type - the operation type

getPublicationDateFrom

java.util.Date getPublicationDateFrom()

Returns the filter publication date from parameter.

Returns:

the publication date from parameter

setPublicationDateFrom

void setPublicationDateFrom(java.util.Date fromDate)

Sets the filter publication date from parameter.

Parameters:

fromDate - the publication date from parameter to set

getPublicationDateTo

java.util.Date getPublicationDateTo()

Returns the filter publication date to parameter.

Returns:

the publication date to parameter

setPublicationDateTo

void setPublicationDateTo(java.util.Date toDate)

Sets the filter publication date to parameter.

Parameters:

toDate - the publication date to parameter to set

getCreatedSince

int getCreatedSince()

Returns the filter created since days parameter.

Returns:

the created since parameter

setCreatedSince

void setCreatedSince(int days)

Sets the filter created since days parameter.

Parameters:

days - the created since parameter to set

getResultFrom

int getResultFrom()

Returns the filter from range parameter.

Returns:

the from range

getResultTo

int getResultTo()

Returns the filter to range parameter.

Returns:

the to range

setResultRange

void setResultRange(int from,
                    int to)

Sets the filter result range parameter.

Parameters:

from - the from range to set

to - the to range to set

getStatus

WorkflowModelState[] getStatus()

Return the filter state.

Returns:

the state

setStatus

void setStatus(WorkflowModelState[] states)

Sets the filter state.

Parameters:

states - the states to set

getExcludeMediaItems

MediaItem[] getExcludeMediaItems()

Returns the filter exclude media items parameter.

Returns:

the exclude media items

setExcludeMediaItems

void setExcludeMediaItems(MediaItem[] mediaItems)

Set the filter exclude media items parameter.

Parameters:

mediaItems - the exclude media items to set

setReferencedResourceInstance

void setReferencedResourceInstance(ResourceInstance resourceInstance)

Set the referenced database resource instance

Parameters:

resourceInstance - the referenced resource instance to set

getReferencedResourceInstance

ResourceInstance getReferencedResourceInstance()

Returns the filter referenced database resource instance

Returns:

the referenced resource instance

getReferencedMediaItem

MediaItem getReferencedMediaItem()

Returns the filter referenced media item.

Returns:

the referenced media item.

setReferencedMediaItem

void setReferencedMediaItem(MediaItem mediaItem)

Sets the filter referenced media item.

Parameters:

dbid - the referenced media item.

getExternalId

java.lang.String getExternalId()

Returns the filter external id parameter. The externalId could have been set during the creation of a mediaItem in ways other than via the regular edit interface.

Returns:

the external id parameter

setExternalId

void setExternalId(java.lang.String externalId)

Sets the filter external id parameter. The externalId can be set during the creation of a mediaItem in ways other than via the regular edit interface in order to be able to retrieve this mediaItem based on that same externalId

Parameters:

externalId - the external id parameter to set

setExpirationDateFrom

void setExpirationDateFrom(java.util.Date fromDate)

Sets the filter expiration fromdate from parameter.

Parameters:

expiration - fromDate

getExpirationDateFrom

java.util.Date getExpirationDateFrom()

Returns the filter expiration date to parameter.

Returns:

the expiration fromDate

setExpirationDateTo

void setExpirationDateTo(java.util.Date toDate)

Sets the filter expiration todate from parameter.

Parameters:

expiration - toDate

getExpirationDateTo

java.util.Date getExpirationDateTo()

Returns the filter expiration date to parameter.

Returns:

the expiration toDate