public interface

Media

implements KnowledgebaseObject
vars.knowledgebase.Media
Known Indirect Subclasses

Summary

Constants
String PROP_CAPTION
String PROP_CREDIT
String PROP_TYPE
String PROP_URL
String[] TYPES
String TYPE_ICON
String TYPE_IMAGE
String TYPE_VIDEO
Public Methods
abstract String getCaption()
Gets the Media 'caption' attribute.
abstract ConceptMetadata getConceptMetadata()
Gets the conceptDelegate attribute of the Media object
abstract String getCredit()
Gets the Media 'credit' attribute.
abstract String getType()
Gets the Media 'type' attribute.
abstract String getUrl()
abstract Boolean isPrimary()
Gets the Media 'primary' attribute.
abstract void setCaption(String caption)
Sets the Media 'caption' attribute.
abstract void setCredit(String credit)
Sets the Media 'credit' attribute.
abstract void setPrimary(Boolean primary)
Sets the Media 'primary' attribute.
abstract void setType(String type)
Sets the Media 'type' attribute.
abstract void setUrl(String url)
abstract String stringValue()
Gets a String representation of this Media suitable for feeding to the method createFromString() to recreate the content of a Media.
[Expand]
Inherited Methods
From interface vars.VARSObject

Constants

public static final String PROP_CAPTION

Constant Value: "caption"

public static final String PROP_CREDIT

Constant Value: "credit"

public static final String PROP_TYPE

Constant Value: "type"

public static final String PROP_URL

Constant Value: "url"

public static final String[] TYPES

public static final String TYPE_ICON

Constant Value: "Icon"

public static final String TYPE_IMAGE

Constant Value: "Image"

public static final String TYPE_VIDEO

Constant Value: "Video"

Public Methods

public abstract String getCaption ()

Gets the Media 'caption' attribute.

Returns
  • The String caption of the Media

public abstract ConceptMetadata getConceptMetadata ()

Gets the conceptDelegate attribute of the Media object

Returns
  • The conceptDelegate value

public abstract String getCredit ()

Gets the Media 'credit' attribute.

Returns
  • The String credit of the Media

public abstract String getType ()

Gets the Media 'type' attribute.

Returns
  • The Type of the Media.

public abstract String getUrl ()

Returns
  • the url

public abstract Boolean isPrimary ()

Gets the Media 'primary' attribute.

Returns
  • The boolean primary of the Media

public abstract void setCaption (String caption)

Sets the Media 'caption' attribute.

Parameters
caption String caption of the Media

public abstract void setCredit (String credit)

Sets the Media 'credit' attribute.

Parameters
credit String credit of the Media

public abstract void setPrimary (Boolean primary)

Sets the Media 'primary' attribute.

Parameters
primary boolean primary of the Media

public abstract void setType (String type)

Sets the Media 'type' attribute.

Parameters
type String representation of a Type for this Media

public abstract void setUrl (String url)

Parameters
url the url to set

public abstract String stringValue ()

Gets a String representation of this Media suitable for feeding to the method createFromString() to recreate the content of a Media. This content is the same as that used in the state-based equals() method.

Returns
  • A String representation of this Media in the format: 
     fileName | type | primary (or additional) | credit | caption