Media (CAFrontEnd API Specification)

java.lang.Object
- service.tut.pori.contentanalysis.Media

Direct Known Subclasses:

FuzzyMedia, Photo, Video
```
public abstract class Media
extends java.lang.Object
```
Abstract base class for media objects

Constructor Summary

Constructors
Constructor and Description
`Media()` for serialization, must be public for solr.
`Media(java.lang.String guid)`
`Media(java.lang.String guid, UserIdentity ownerUserId, CAContentCore.ServiceType serviceType, CAContentCore.Visibility visibility)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addackendStatus(BackendStatus backend)`
`void`	`addMediaObject(MediaObject object)` Adds the given object, NOTE: this will NOT check for duplicates.
`void`	`addMediaObjects(MediaObjectList mediaObjects)` Adds the given objects, NOTE: this will NOT check for duplicates.
`BackendStatusList`	`getBackendStatus()` Default data groups: backend_status
`java.lang.String`	`getCredits()` Default data groups: basic
`java.lang.String`	`getDescription()` Default data groups: basic
`java.lang.String`	`getGUID()` Default data groups: basic, defaults
`MediaObjectList`	`getMediaObjects()` Default data groups: defaults
`MediaUrlValidator.MediaType`	`getMediaType()`
`java.lang.Integer`	`getMediaTypeValue()`
`java.lang.String`	`getName()` Default data groups: basic
`UserIdentity`	`getOwnerUserId()` Default data groups: basic, defaults
`java.lang.Long`	`getOwnerUserIdValue()`
`java.lang.Integer`	`getServiceId()`
`CAContentCore.ServiceType`	`getServiceType()` Default data groups: basic, defaults
`java.util.Date`	`getUpdated()`
`java.lang.String`	`getUrl()` Default data groups: basic, defaults
`CAContentCore.Visibility`	`getVisibility()` Default data groups: basic, visibility If visibility is not available, it should be assumed to be `CAContentCore.Visibility.PRIVATE`
`java.lang.Integer`	`getVisibilityValue()`
`static boolean`	`isValid(Media media)`
`void`	`setBackendStatus(BackendStatusList backendStatus)`
`void`	`setCredits(java.lang.String credits)`
`void`	`setDescription(java.lang.String description)`
`void`	`setGUID(java.lang.String guid)`
`void`	`setMediaObjects(MediaObjectList mediaObjects)`
`void`	`setMediaType(MediaUrlValidator.MediaType mediaType)`
`void`	`setName(java.lang.String name)`
`void`	`setOwnerUserId(UserIdentity ownerId)`
`void`	`setServiceType(CAContentCore.ServiceType type)`
`void`	`setUpdated(java.util.Date updated)`
`void`	`setUrl(java.lang.String url)`
`void`	`setVisibility(CAContentCore.Visibility visibility)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Media
```
public Media()
```
    for serialization, must be public for solr.
  - Media
```
public Media(java.lang.String guid)
```
    Parameters:
    
    guid -
  - Media
```
public Media(java.lang.String guid,
             UserIdentity ownerUserId,
             CAContentCore.ServiceType serviceType,
             CAContentCore.Visibility visibility)
```
    Parameters:
    
    guid -
    
    ownerUserId -
    
    serviceType -
    
    visibility -
- Method Detail
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Parameters:
    
    url -
    
    See Also:
    
    getUrl()
  - getUrl
```
public java.lang.String getUrl()
```
    Default data groups: basic, defaults
    
    Returns:
    
    url
    
    See Also:
    
    setUrl(String)
  - getBackendStatus
```
public BackendStatusList getBackendStatus()
```
    Default data groups: backend_status
    
    Returns:
    
    back-end status for this media or null if not available
    
    See Also:
    
    setBackendStatus(BackendStatusList)
  - setBackendStatus
```
public void setBackendStatus(BackendStatusList backendStatus)
```
    Parameters:
    
    backendStatus -
    
    See Also:
    
    getBackendStatus()
  - addackendStatus
```
public void addackendStatus(BackendStatus backend)
```
    Parameters:
    
    backend -
    
    See Also:
    
    getBackendStatus()
  - getMediaObjects
```
public MediaObjectList getMediaObjects()
```
    Default data groups: defaults
    
    Returns:
    
    media objects or null if not available
    
    See Also:
    
    setMediaObjects(MediaObjectList)
  - setMediaObjects
```
public void setMediaObjects(MediaObjectList mediaObjects)
```
    Parameters:
    
    mediaObjects -
    
    See Also:
    
    getMediaObjects()
  - addMediaObject
```
public void addMediaObject(MediaObject object)
```
    Adds the given object, NOTE: this will NOT check for duplicates.
    
    Parameters:
    
    object -
    
    See Also:
    
    getMediaObjects()
  - addMediaObjects
```
public void addMediaObjects(MediaObjectList mediaObjects)
```
    Adds the given objects, NOTE: this will NOT check for duplicates.
    
    Parameters:
    
    mediaObjects -
    
    See Also:
    
    getMediaObjects()
  - setServiceType
```
public void setServiceType(CAContentCore.ServiceType type)
```
    Parameters:
    
    type -
    
    See Also:
    
    getServiceType()
  - getServiceType
```
public CAContentCore.ServiceType getServiceType()
```
    Default data groups: basic, defaults
    
    Returns:
    
    the service this media originated from
    
    See Also:
    
    setServiceType(service.tut.pori.contentanalysis.CAContentCore.ServiceType)
  - getServiceId
```
public java.lang.Integer getServiceId()
```
    Returns:
    
    the service id
    
    See Also:
    
    getServiceType()
  - getGUID
```
public java.lang.String getGUID()
```
    Default data groups: basic, defaults
    
    Returns:
    
    guid
    
    See Also:
    
    setGUID(String)
  - setGUID
```
public void setGUID(java.lang.String guid)
```
    Parameters:
    
    guid -
    
    See Also:
    
    getGUID()
  - getOwnerUserIdValue
```
public java.lang.Long getOwnerUserIdValue()
```
    Returns:
    
    user identity value
    
    See Also:
    
    getOwnerUserId()
  - getOwnerUserId
```
public UserIdentity getOwnerUserId()
```
    Default data groups: basic, defaults
    
    Returns:
    
    media owner
    
    See Also:
    
    setOwnerUserId(UserIdentity)
  - setOwnerUserId
```
public void setOwnerUserId(UserIdentity ownerId)
```
    Parameters:
    
    ownerId - the media's owner's user id
    
    See Also:
    
    getOwnerUserId()
  - isValid
```
public static boolean isValid(Media media)
```
    Parameters:
    
    media - can be null
    
    Returns:
    
    true if the given media is valid
  - getCredits
```
public java.lang.String getCredits()
```
    Default data groups: basic
    
    Returns:
    
    credits information for the media (e.g. Creative Commons) or null if not available
    
    See Also:
    
    setCredits(String)
  - setCredits
```
public void setCredits(java.lang.String credits)
```
    Parameters:
    
    credits -
    
    See Also:
    
    getCredits()
  - getName
```
public java.lang.String getName()
```
    Default data groups: basic
    
    Returns:
    
    name of the media or null if not available
    
    See Also:
    
    setName(String)
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name -
    
    See Also:
    
    getName()
  - getDescription
```
public java.lang.String getDescription()
```
    Default data groups: basic
    
    Returns:
    
    description of the media or null if not available
    
    See Also:
    
    setDescription(String)
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Parameters:
    
    description -
    
    See Also:
    
    getDescription()
  - setVisibility
```
public void setVisibility(CAContentCore.Visibility visibility)
```
    Parameters:
    
    visibility -
    
    See Also:
    
    getVisibility()
  - getVisibility
```
public CAContentCore.Visibility getVisibility()
```
    Default data groups: basic, visibility If visibility is not available, it should be assumed to be CAContentCore.Visibility.PRIVATE
    
    Returns:
    
    visibility or null if not available
    
    See Also:
    
    setVisibility(service.tut.pori.contentanalysis.CAContentCore.Visibility)
  - getVisibilityValue
```
public java.lang.Integer getVisibilityValue()
```
    Returns:
    
    visibility value
    
    See Also:
    
    getVisibility()
  - getUpdated
```
public java.util.Date getUpdated()
```
    Returns:
    
    the updated
  - setUpdated
```
public void setUpdated(java.util.Date updated)
```
    Parameters:
    
    updated - the updated to set
  - getMediaType
```
public MediaUrlValidator.MediaType getMediaType()
```
    Returns:
    
    the mediaType
  - setMediaType
```
public void setMediaType(MediaUrlValidator.MediaType mediaType)
```
    Parameters:
    
    mediaType - the mediaType to set
  - getMediaTypeValue
```
public java.lang.Integer getMediaTypeValue()
```
    Returns:
    
    mediaType value
    
    See Also:
    
    getMediaType()

Class Media

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Media

Media

Media

Method Detail

setUrl

getUrl

getBackendStatus

setBackendStatus

addackendStatus

getMediaObjects

setMediaObjects

addMediaObject

addMediaObjects

setServiceType

getServiceType

getServiceId

getGUID

setGUID

getOwnerUserIdValue

getOwnerUserId

setOwnerUserId

isValid

getCredits

setCredits

getName

setName

getDescription

setDescription

setVisibility

getVisibility

getVisibilityValue

getUpdated

setUpdated

getMediaType

setMediaType

getMediaTypeValue