From 8342118b800fd56d6b26bab279b2088e551dba92 Mon Sep 17 00:00:00 2001 From: kingTarun Date: Thu, 22 Aug 2013 16:58:39 -0400 Subject: [PATCH] Added 'PENDING' status check when videos come from jsonobject --- .../commons/catalog/objects/Video.html | 1968 ++++++++--------- .../objects/enumerations/ItemStateEnum.html | 53 +- .../commons/catalog/objects/Video.java | 12 +- .../objects/enumerations/ItemStateEnum.java | 2 +- .../commons/catalog/objects/Video.html | 1968 ++++++++--------- .../objects/enumerations/ItemStateEnum.html | 53 +- 6 files changed, 2046 insertions(+), 2010 deletions(-) diff --git a/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/Video.html b/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/Video.html index 41bbee98..d7d9b3f8 100755 --- a/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/Video.html +++ b/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/Video.html @@ -98,22 +98,22 @@

-

- A Video object (the metadata defining a video). -

- -

- This object is defined primarily by the Media API documentation for - a Video object: - http://support.brightcove.com/en/docs/media-api-objects-reference#Video. -

-

- This may be modified however from the Media API documentation so that it - can also support other interfaces (e.g. batch provisioning).

-

- - The Video object is an aggregate of metadata and asset information associated with a video. - +

+ A Video object (the metadata defining a video). +

+ +

+ This object is defined primarily by the Media API documentation for + a Video object: + http://support.brightcove.com/en/docs/media-api-objects-reference#Video. +

+

+ This may be modified however from the Media API documentation so that it + can also support other interfaces (e.g. batch provisioning).

+

+ + The Video object is an aggregate of metadata and asset information associated with a video. +

@@ -138,28 +138,28 @@

Video()
-           +           Default Constructor. Video(org.w3c.dom.Element element)
-           +           Constructs a new video from an XML representation (generated by Videos.toXml()). Video(org.json.JSONObject jsonObj)
-           +           Constructor using JSON object. Video(java.lang.String json)
-           +           Constructor using JSON string. @@ -178,8 +178,8 @@

appendXml(org.w3c.dom.Element root)
-           - Uses the W3C libraries to generate an XML representation of +           + Uses the W3C libraries to generate an XML representation of this object. @@ -188,7 +188,7 @@

getAccountId()
-           +           Gets the account id for this Video. @@ -197,7 +197,7 @@

getAdKeys()
-           +           Gets the ad keys for this Video. @@ -206,7 +206,7 @@

getCreationDate()
-           +           Gets the creation date for this Video. @@ -215,7 +215,7 @@

getCuePoints()
-           +           Gets the cue points for this Video. @@ -224,7 +224,7 @@

getCustomFields()
-           +           Gets the custom fields for this Video. @@ -233,7 +233,7 @@

getEconomics()
-           +           Gets the economics for this Video. @@ -242,7 +242,7 @@

getEndDate()
-           +           Gets the end date for this Video. @@ -251,7 +251,7 @@

getFlvUrl()
-           +           Gets the FLV URL for this Video. @@ -260,7 +260,7 @@

getGeoFiltered()
-           +           Gets the geo filtered state for this Video. @@ -269,7 +269,7 @@

getGeoFilteredCountries()
-           +           Gets the geo-filtered countries for this Video. @@ -278,7 +278,7 @@

getGeoFilteredExclude()
-           +           Gets the geo filtered exclude state for this Video. @@ -287,7 +287,7 @@

getId()
-           +           Gets the id for this Video. @@ -296,7 +296,7 @@

getIOSRenditions()
-           +           Gets the iOS renditions for this Video. @@ -305,7 +305,7 @@

getItemState()
-           +           Gets the item state for this Video. @@ -314,7 +314,7 @@

getLastModifiedDate()
-           +           Gets the last modified date for this Video. @@ -323,7 +323,7 @@

getLength()
-           +           Gets the length for this Video. @@ -332,7 +332,7 @@

getLinkText()
-           +           Gets the related link text for this Video. @@ -341,7 +341,7 @@

getLinkUrl()
-           +           Gets the related link URL for this Video. @@ -350,7 +350,7 @@

getLongDescription()
-           +           Gets the long description for this Video. @@ -359,7 +359,7 @@

getName()
-           +           Gets the name (title) for this Video. @@ -368,7 +368,7 @@

getPlaysTotal()
-           +           Gets the plays total count for this Video. @@ -377,7 +377,7 @@

getPlaysTrailingWeek()
-           +           Gets the plays trailing week count for this Video. @@ -386,7 +386,7 @@

getPublishedDate()
-           +           Gets the published date for this Video. @@ -395,7 +395,7 @@

getReferenceId()
-           +           Gets the reference id for this Video. @@ -412,7 +412,7 @@

getRenditions()
-           +           Gets the renditions for this Video. @@ -421,7 +421,7 @@

getShortDescription()
-           +           Gets the short description for this Video. @@ -430,7 +430,7 @@

getStartDate()
-           +           Gets the start date for this Video. @@ -439,7 +439,7 @@

getTags()
-           +           Gets the keyword tags for this Video. @@ -448,7 +448,7 @@

getThumbnailUrl()
-           +           Gets the thumbnail URL for this Video. @@ -457,7 +457,7 @@

getVideoFullLength()
-           +           Gets the full length rendition for this Video. @@ -466,7 +466,7 @@

getVideoStillUrl()
-           +           Gets the video still URL for this Video. @@ -475,7 +475,7 @@

initAll()
-           +           Fully initializes the video object by setting all fields to null @@ -484,7 +484,7 @@

setAccountId(java.lang.Long accountId)
-           +           Sets the account id for this Video. @@ -493,7 +493,7 @@

setAdKeys(java.lang.String adKeys)
-           +           Sets the ad keys for this Video. @@ -502,7 +502,7 @@

setCreationDate(java.util.Date creationDate)
-           +           Sets the creation date for this Video. @@ -511,7 +511,7 @@

setCuePoints(java.util.List<CuePoint> cuePoints)
-           +           Sets the cue points for this Video. @@ -520,7 +520,7 @@

setCustomFields(java.util.List<CustomField> customFields)
-           +           Sets the custom fields for this Video. @@ -529,7 +529,7 @@

setEconomics(EconomicsEnum economics)
-           +           Sets the economics for this Video. @@ -538,7 +538,7 @@

setEndDate(java.util.Date endDate)
-           +           Sets the end date for this Video. @@ -547,7 +547,7 @@

setFlvUrl(java.lang.String flvUrl)
-           +           Sets the FLV URL for this Video. @@ -556,7 +556,7 @@

setGeoFiltered(java.lang.Boolean geoFiltered)
-           +           Sets the geo filtered state for this Video. @@ -565,7 +565,7 @@

setGeoFilteredCountries(java.util.List<GeoFilterCodeEnum> geoFilteredCountries)
-           +           Sets the geo-filtered countries for this Video. @@ -574,7 +574,7 @@

setGeoFilteredExclude(java.lang.Boolean geoFilteredExclude)
-           +           Sets the geo filtered exclude state for this Video. @@ -583,7 +583,7 @@

setId(java.lang.Long id)
-           +           Sets the id for this Video. @@ -592,7 +592,7 @@

setIOSRenditions(java.util.List<iosRendition> renditions)
-           +           Sets the iOS renditions for this Video. @@ -601,7 +601,7 @@

setItemState(ItemStateEnum itemState)
-           +           Sets the item state for this Video. @@ -610,7 +610,7 @@

setLastModifiedDate(java.util.Date lastModifiedDate)
-           +           Sets the last modified date for this Video. @@ -619,7 +619,7 @@

setLength(java.lang.Long length)
-           +           Sets the length for this Video. @@ -628,7 +628,7 @@

setLinkText(java.lang.String linkText)
-           +           Sets the related link text for this Video. @@ -637,7 +637,7 @@

setLinkUrl(java.lang.String linkUrl)
-           +           Sets the related link URL for this Video. @@ -646,7 +646,7 @@

setLongDescription(java.lang.String longDescription)
-           +           Sets the long description for this Video. @@ -655,7 +655,7 @@

setName(java.lang.String name)
-           +           Sets the name (title) for this Video. @@ -664,7 +664,7 @@

setPlaysTotal(java.lang.Integer playsTotal)
-           +           Sets the plays total count for this Video. @@ -673,7 +673,7 @@

setPlaysTrailingWeek(java.lang.Integer playsTrailingWeek)
-           +           Sets the plays trailing week count for this Video. @@ -682,7 +682,7 @@

setPublishedDate(java.util.Date publishedDate)
-           +           Sets the published date for this Video. @@ -691,7 +691,7 @@

setReferenceId(java.lang.String referenceId)
-           +           Sets the reference id for this Video. @@ -700,7 +700,7 @@

setReleaseDate(java.util.Date releaseDate)
-           +           Sets the release date for this Video. @@ -709,7 +709,7 @@

setRenditions(java.util.List<Rendition> renditions)
-           +           Sets the renditions for this Video. @@ -718,7 +718,7 @@

setShortDescription(java.lang.String shortDescription)
-           +           Sets the short description for this Video. @@ -727,7 +727,7 @@

setStartDate(java.util.Date startDate)
-           +           Sets the start date for this Video. @@ -736,7 +736,7 @@

setTags(java.util.List<java.lang.String> tags)
-           +           Sets the keyword tags for this Video. @@ -745,7 +745,7 @@

setThumbnailUrl(java.lang.String thumbnailUrl)
-           +           Sets the thumbnail URL for this Video. @@ -754,7 +754,7 @@

setVideoFullLength(Rendition videoFullLength)
-           +           Sets the full length rendition for this Video. @@ -763,7 +763,7 @@

setVideoStillUrl(java.lang.String videoStillUrl)
-           +           Sets the video still URL for this Video. @@ -772,7 +772,7 @@

toJson()
-           +           Converts the video into a JSON object suitable for use with the Media API @@ -781,7 +781,7 @@

toJson(java.util.EnumSet<VideoFieldEnum> includeNullFields)
-           +           Converts the video into a JSON object suitable for use with the Media API @@ -820,13 +820,13 @@ 

 public Video()
-

- Default Constructor. -

- -

- All fields set to null to start - required fields must be set before - calling Write Media API. +

+ Default Constructor. +

+ +

+ All fields set to null to start - required fields must be set before + calling Write Media API.

@@ -838,14 +838,14 @@

public Video(java.lang.String json) throws org.json.JSONException
-

- Constructor using JSON string. -

- -

- Given a JSON string from the Media API, attempts to construct a new - Video object and fill out all of the fields defined. All other - fields will be null. +

+ Constructor using JSON string. +

+ +

+ Given a JSON string from the Media API, attempts to construct a new + Video object and fill out all of the fields defined. All other + fields will be null.

@@ -861,14 +861,14 @@

public Video(org.json.JSONObject jsonObj) throws org.json.JSONException
-

- Constructor using JSON object. -

- -

- Given a JSON object from the Media API, attempts to construct a new - Video object and fill out all of the fields defined. All other - fields will be null. +

+ Constructor using JSON object. +

+ +

+ Given a JSON object from the Media API, attempts to construct a new + Video object and fill out all of the fields defined. All other + fields will be null.

@@ -883,8 +883,8 @@ 

 public Video(org.w3c.dom.Element element)
-

- Constructs a new video from an XML representation (generated by Videos.toXml()). +

+ Constructs a new video from an XML representation (generated by Videos.toXml()).

@@ -906,8 +906,8 @@ 

 public void initAll()
-

- Fully initializes the video object by setting all fields to null +

+ Fully initializes the video object by setting all fields to null

@@ -921,19 +921,19 @@ 

 public java.lang.String getName()
-

- Gets the name (title) for this Video. -

- -

- - Property name: name
- Type: String
- Read only?: no
- Description: The title of the Video, limited to 255 - characters. The name is a required property - when you create a video. - +

+ Gets the name (title) for this Video. +

+ +

+ + Property name: name
+ Type: String
+ Read only?: no
+ Description: The title of the Video, limited to 255 + characters. The name is a required property + when you create a video. +

@@ -948,19 +948,19 @@ 

 public void setName(java.lang.String name)
-

- Sets the name (title) for this Video. -

- -

- - Property name: name
- Type: String
- Read only?: no
- Description: The title of the Video, limited to 255 - characters. The name is a required property - when you create a video. - +

+ Sets the name (title) for this Video. +

+ +

+ + Property name: name
+ Type: String
+ Read only?: no
+ Description: The title of the Video, limited to 255 + characters. The name is a required property + when you create a video. +

@@ -974,19 +974,19 @@ 

 public java.lang.Long getId()
-

- Gets the id for this Video. -

- -

- - Property name: id
- Type: long
- Read only?: yes
- Description: A number that uniquely identifies this Video, - assigned by Brightcove when the Video is - created. - +

+ Gets the id for this Video. +

+ +

+ + Property name: id
+ Type: long
+ Read only?: yes
+ Description: A number that uniquely identifies this Video, + assigned by Brightcove when the Video is + created. +

@@ -1001,19 +1001,19 @@ 

 public void setId(java.lang.Long id)
-

- Sets the id for this Video. -

- -

- - Property name: id
- Type: long
- Read only?: yes
- Description: A number that uniquely identifies this Video, - assigned by Brightcove when the Video is - created. - +

+ Sets the id for this Video. +

+ +

+ + Property name: id
+ Type: long
+ Read only?: yes
+ Description: A number that uniquely identifies this Video, + assigned by Brightcove when the Video is + created. +

@@ -1027,24 +1027,24 @@ 

 public java.lang.String getReferenceId()
-

- Gets the reference id for this Video. -

- -

- - Property name: referenceId
- Type: String
- Read only?: no
- Description: A user-specified id that uniquely identifies - the Video, limited to 150 characters. A - referenceId can be used as a foreign-key to - identify this video in another system. Note - that that the find_videos_by_reference_ids - method cannot handle a referenceId that contain - commas, so you may want to avoid using commas - in referenceId values. - +

+ Gets the reference id for this Video. +

+ +

+ + Property name: referenceId
+ Type: String
+ Read only?: no
+ Description: A user-specified id that uniquely identifies + the Video, limited to 150 characters. A + referenceId can be used as a foreign-key to + identify this video in another system. Note + that that the find_videos_by_reference_ids + method cannot handle a referenceId that contain + commas, so you may want to avoid using commas + in referenceId values. +

@@ -1059,24 +1059,24 @@ 

 public void setReferenceId(java.lang.String referenceId)
-

- Sets the reference id for this Video. -

- -

- - Property name: referenceId
- Type: String
- Read only?: no
- Description: A user-specified id that uniquely identifies - the Video, limited to 150 characters. A - referenceId can be used as a foreign-key to - identify this video in another system. Note - that that the find_videos_by_reference_ids - method cannot handle a referenceId that contain - commas, so you may want to avoid using commas - in referenceId values. - +

+ Sets the reference id for this Video. +

+ +

+ + Property name: referenceId
+ Type: String
+ Read only?: no
+ Description: A user-specified id that uniquely identifies + the Video, limited to 150 characters. A + referenceId can be used as a foreign-key to + identify this video in another system. Note + that that the find_videos_by_reference_ids + method cannot handle a referenceId that contain + commas, so you may want to avoid using commas + in referenceId values. +

@@ -1090,19 +1090,19 @@ 

 public java.lang.Long getAccountId()
-

- Gets the account id for this Video. -

- -

- - Property name: accountId
- Type: long
- Read only?: yes
- Description: A number, assigned by Brightcove, that uniquely - identifies the account to which the Video - belongs. - +

+ Gets the account id for this Video. +

+ +

+ + Property name: accountId
+ Type: long
+ Read only?: yes
+ Description: A number, assigned by Brightcove, that uniquely + identifies the account to which the Video + belongs. +

@@ -1117,19 +1117,19 @@ 

 public void setAccountId(java.lang.Long accountId)
-

- Sets the account id for this Video. -

- -

- - Property name: accountId
- Type: long
- Read only?: yes
- Description: A number, assigned by Brightcove, that uniquely - identifies the account to which the Video - belongs. - +

+ Sets the account id for this Video. +

+ +

+ + Property name: accountId
+ Type: long
+ Read only?: yes
+ Description: A number, assigned by Brightcove, that uniquely + identifies the account to which the Video + belongs. +

@@ -1143,19 +1143,19 @@ 

 public java.lang.String getShortDescription()
-

- Gets the short description for this Video. -

- -

- - Property name: shortDescription
- Type: String
- Read only?: no
- Description: A short description describing the Video, - limited to 250 characters. The shortDescription - is a required property when you create a video. - +

+ Gets the short description for this Video. +

+ +

+ + Property name: shortDescription
+ Type: String
+ Read only?: no
+ Description: A short description describing the Video, + limited to 250 characters. The shortDescription + is a required property when you create a video. +

@@ -1170,19 +1170,19 @@ 

 public void setShortDescription(java.lang.String shortDescription)
-

- Sets the short description for this Video. -

- -

- - Property name: shortDescription
- Type: String
- Read only?: no
- Description: A short description describing the Video, - limited to 250 characters. The shortDescription - is a required property when you create a video. - +

+ Sets the short description for this Video. +

+ +

+ + Property name: shortDescription
+ Type: String
+ Read only?: no
+ Description: A short description describing the Video, + limited to 250 characters. The shortDescription + is a required property when you create a video. +

@@ -1196,18 +1196,18 @@ 

 public java.lang.String getLongDescription()
-

- Gets the long description for this Video. -

- -

- - Property name: longDescription
- Type: String
- Read only?: no
- Description: A longer description of this Video, limited to - 5000 characters. - +

+ Gets the long description for this Video. +

+ +

+ + Property name: longDescription
+ Type: String
+ Read only?: no
+ Description: A longer description of this Video, limited to + 5000 characters. +

@@ -1222,18 +1222,18 @@ 

 public void setLongDescription(java.lang.String longDescription)
-

- Sets the long description for this Video. -

- -

- - Property name: longDescription
- Type: String
- Read only?: no
- Description: A longer description of this Video, limited to - 5000 characters. - +

+ Sets the long description for this Video. +

+ +

+ + Property name: longDescription
+ Type: String
+ Read only?: no
+ Description: A longer description of this Video, limited to + 5000 characters. +

@@ -1247,23 +1247,23 @@ 

 public java.lang.String getFlvUrl()
-

- Gets the FLV URL for this Video. -

- -

- - Property name: FLVURL
- Type: String
- Read only?: yes
- Description: The URL of the video file for this Video. Note - that this property can be accessed with the - Media API only with a special read or write - token. This property applies, no matter whether - the video's encoding is FLV (VP6) or MP4 - (H.264). See - Accessing Video Content with the Media API. - +

+ Gets the FLV URL for this Video. +

+ +

+ + Property name: FLVURL
+ Type: String
+ Read only?: yes
+ Description: The URL of the video file for this Video. Note + that this property can be accessed with the + Media API only with a special read or write + token. This property applies, no matter whether + the video's encoding is FLV (VP6) or MP4 + (H.264). See + Accessing Video Content with the Media API. +

@@ -1278,23 +1278,23 @@ 

 public void setFlvUrl(java.lang.String flvUrl)
-

- Sets the FLV URL for this Video. -

- -

- - Property name: FLVURL
- Type: String
- Read only?: yes
- Description: The URL of the video file for this Video. Note - that this property can be accessed with the - Media API only with a special read or write - token. This property applies, no matter whether - the video's encoding is FLV (VP6) or MP4 - (H.264). See - Accessing Video Content with the Media API. - +

+ Sets the FLV URL for this Video. +

+ +

+ + Property name: FLVURL
+ Type: String
+ Read only?: yes
+ Description: The URL of the video file for this Video. Note + that this property can be accessed with the + Media API only with a special read or write + token. This property applies, no matter whether + the video's encoding is FLV (VP6) or MP4 + (H.264). See + Accessing Video Content with the Media API. +

@@ -1308,25 +1308,25 @@ 

 public java.util.List<Rendition> getRenditions()
-

- Gets the renditions for this Video. -

- -

- - Property name: renditions
- Type: Array
- Read only?: no
- Description: An array of - Renditions - that represent the multi-bitrate streaming - renditions available for this Video. A Video - should have not more than 10 Renditions. Note - that this property can be accessed with the - Media API only with a special read or write - token. See - Accessing Video Content with the Media API. - +

+ Gets the renditions for this Video. +

+ +

+ + Property name: renditions
+ Type: Array
+ Read only?: no
+ Description: An array of + Renditions + that represent the multi-bitrate streaming + renditions available for this Video. A Video + should have not more than 10 Renditions. Note + that this property can be accessed with the + Media API only with a special read or write + token. See + Accessing Video Content with the Media API. +

@@ -1341,25 +1341,25 @@ 

 public void setRenditions(java.util.List<Rendition> renditions)
-

- Sets the renditions for this Video. -

- -

- - Property name: renditions
- Type: Array
- Read only?: no
- Description: An array of - Renditions - that represent the multi-bitrate streaming - renditions available for this Video. A Video - should have not more than 10 Renditions. Note - that this property can be accessed with the - Media API only with a special read or write - token. See - Accessing Video Content with the Media API. - +

+ Sets the renditions for this Video. +

+ +

+ + Property name: renditions
+ Type: Array
+ Read only?: no
+ Description: An array of + Renditions + that represent the multi-bitrate streaming + renditions available for this Video. A Video + should have not more than 10 Renditions. Note + that this property can be accessed with the + Media API only with a special read or write + token. See + Accessing Video Content with the Media API. +

@@ -1373,17 +1373,17 @@ 

 public java.util.List<Rendition> getIOSRenditions()
-

- Gets the iOS renditions for this Video. -

- -

- - Property name: iosRenditions
- Type: Array
- Read only?: no
- Description: - +

+ Gets the iOS renditions for this Video. +

+ +

+ + Property name: iosRenditions
+ Type: Array
+ Read only?: no
+ Description: +

@@ -1398,17 +1398,17 @@ 

 public void setIOSRenditions(java.util.List<iosRendition> renditions)
-

- Sets the iOS renditions for this Video. -

- -

- - Property name: iosRenditions
- Type: Array
- Read only?: no
- Description: - +

+ Sets the iOS renditions for this Video. +

+ +

+ + Property name: iosRenditions
+ Type: Array
+ Read only?: no
+ Description: +

@@ -1422,23 +1422,23 @@ 

 public Rendition getVideoFullLength()
-

- Gets the full length rendition for this Video. -

- -

- - Property name: videoFullLength
- Type: Rendition
- Read only?: no
- Description: A single - Rendition - that represents the the video file for the - Video. Note that this property can be accessed - with the Media API only with a special read or - write token. See - Accessing Video Content with the Media API. - +

+ Gets the full length rendition for this Video. +

+ +

+ + Property name: videoFullLength
+ Type: Rendition
+ Read only?: no
+ Description: A single + Rendition + that represents the the video file for the + Video. Note that this property can be accessed + with the Media API only with a special read or + write token. See + Accessing Video Content with the Media API. +

@@ -1453,23 +1453,23 @@ 

 public void setVideoFullLength(Rendition videoFullLength)
-

- Sets the full length rendition for this Video. -

- -

- - Property name: videoFullLength
- Type: Rendition
- Read only?: no
- Description: A single - Rendition - that represents the the video file for the - Video. Note that this property can be accessed - with the Media API only with a special read or - write token. See - Accessing Video Content with the Media API. - +

+ Sets the full length rendition for this Video. +

+ +

+ + Property name: videoFullLength
+ Type: Rendition
+ Read only?: no
+ Description: A single + Rendition + that represents the the video file for the + Video. Note that this property can be accessed + with the Media API only with a special read or + write token. See + Accessing Video Content with the Media API. +

@@ -1483,19 +1483,19 @@ 

 public java.util.Date getCreationDate()
-

- Gets the creation date for this Video. -

- -

- - Property name: creationDate
- Type: Date
- Read only?: yes
- Description: The date this Video was created, represented as - the number of milliseconds since the UNIX - epoch. - +

+ Gets the creation date for this Video. +

+ +

+ + Property name: creationDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was created, represented as + the number of milliseconds since the UNIX + epoch. +

@@ -1510,19 +1510,19 @@ 

 public void setCreationDate(java.util.Date creationDate)
-

- Sets the creation date for this Video. -

- -

- - Property name: creationDate
- Type: Date
- Read only?: yes
- Description: The date this Video was created, represented as - the number of milliseconds since the UNIX - epoch. - +

+ Sets the creation date for this Video. +

+ +

+ + Property name: creationDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was created, represented as + the number of milliseconds since the UNIX + epoch. +

@@ -1536,19 +1536,19 @@ 

 public java.util.Date getPublishedDate()
-

- Gets the published date for this Video. -

- -

- - Property name: publishedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last made active, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Gets the published date for this Video. +

+ +

+ + Property name: publishedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last made active, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1563,19 +1563,19 @@ 

 public void setPublishedDate(java.util.Date publishedDate)
-

- Sets the published date for this Video. -

- -

- - Property name: publishedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last made active, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Sets the published date for this Video. +

+ +

+ + Property name: publishedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last made active, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1589,19 +1589,19 @@ 

 public java.util.Date getLastModifiedDate()
-

- Gets the last modified date for this Video. -

- -

- - Property name: lastModifiedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last modified, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Gets the last modified date for this Video. +

+ +

+ + Property name: lastModifiedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last modified, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1616,19 +1616,19 @@ 

 public void setLastModifiedDate(java.util.Date lastModifiedDate)
-

- Sets the last modified date for this Video. -

- -

- - Property name: lastModifiedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last modified, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Sets the last modified date for this Video. +

+ +

+ + Property name: lastModifiedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last modified, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1642,12 +1642,12 @@ 

 public java.util.Date getReleaseDate()
-

Gets the release date for this Video.

- -

- - undocumented - +

Gets the release date for this Video.

+ +

+ + undocumented +

@@ -1662,14 +1662,14 @@ 

 public void setReleaseDate(java.util.Date releaseDate)
-

- Sets the release date for this Video. -

- -

- - undocumented - +

+ Sets the release date for this Video. +

+ +

+ + undocumented +

@@ -1683,22 +1683,22 @@ 

 public ItemStateEnum getItemState()
-

- Gets the item state for this Video. -

- -

- - Property name: itemState
- Type: Enum
- Read only?: no
- Description: An - ItemStateEnum. - One of the properties: ACTIVE, INACTIVE, or - DELETED. You can set this property only to - ACTIVE or INACTIVE; you cannot delete a video - by setting its itemState to DELETED. - +

+ Gets the item state for this Video. +

+ +

+ + Property name: itemState
+ Type: Enum
+ Read only?: no
+ Description: An + ItemStateEnum. + One of the properties: ACTIVE, INACTIVE, PENDING, or + DELETED. You can set this property only to + ACTIVE or INACTIVE; you cannot delete a video + by setting its itemState to DELETED. +

@@ -1713,22 +1713,22 @@ 

 public void setItemState(ItemStateEnum itemState)
-

- Sets the item state for this Video. -

- -

- - Property name: itemState
- Type: Enum
- Read only?: no
- Description: An - ItemStateEnum. - One of the properties: ACTIVE, INACTIVE, or - DELETED. You can set this property only to - ACTIVE or INACTIVE; you cannot delete a video - by setting its itemState to DELETED. - +

+ Sets the item state for this Video. +

+ +

+ + Property name: itemState
+ Type: Enum
+ Read only?: no
+ Description: An + ItemStateEnum. + One of the properties: ACTIVE, INACTIVE, PENDING or + DELETED. You can set this property only to + ACTIVE or INACTIVE; you cannot delete a video + by setting its itemState to DELETED. +

@@ -1742,19 +1742,19 @@ 

 public java.util.Date getStartDate()
-

- Gets the start date for this Video. -

- -

- - Property name: startDate
- Type: Date
- Read only?: no
- Description: The first date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Gets the start date for this Video. +

+ +

+ + Property name: startDate
+ Type: Date
+ Read only?: no
+ Description: The first date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1769,19 +1769,19 @@ 

 public void setStartDate(java.util.Date startDate)
-

- Sets the start date for this Video. -

- -

- - Property name: startDate
- Type: Date
- Read only?: no
- Description: The first date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Sets the start date for this Video. +

+ +

+ + Property name: startDate
+ Type: Date
+ Read only?: no
+ Description: The first date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1795,19 +1795,19 @@ 

 public java.util.Date getEndDate()
-

- Gets the end date for this Video. -

- -

- - Property name: endDate
- Type: Date
- Read only?: no
- Description: The last date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Gets the end date for this Video. +

+ +

+ + Property name: endDate
+ Type: Date
+ Read only?: no
+ Description: The last date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1822,19 +1822,19 @@ 

 public void setEndDate(java.util.Date endDate)
-

- Sets the end date for this Video. -

- -

- - Property name: endDate
- Type: Date
- Read only?: no
- Description: The last date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Sets the end date for this Video. +

+ +

+ + Property name: endDate
+ Type: Date
+ Read only?: no
+ Description: The last date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1848,18 +1848,18 @@ 

 public java.lang.String getLinkUrl()
-

- Gets the related link URL for this Video. -

- -

- - Property name: linkURL
- Type: String
- Read only?: no
- Description: An optional URL to a related item, limited to - 255 characters. - +

+ Gets the related link URL for this Video. +

+ +

+ + Property name: linkURL
+ Type: String
+ Read only?: no
+ Description: An optional URL to a related item, limited to + 255 characters. +

@@ -1874,18 +1874,18 @@ 

 public void setLinkUrl(java.lang.String linkUrl)
-

- Sets the related link URL for this Video. -

- -

- - Property name: linkURL
- Type: String
- Read only?: no
- Description: An optional URL to a related item, limited to - 255 characters. - +

+ Sets the related link URL for this Video. +

+ +

+ + Property name: linkURL
+ Type: String
+ Read only?: no
+ Description: An optional URL to a related item, limited to + 255 characters. +

@@ -1899,18 +1899,18 @@ 

 public java.lang.String getLinkText()
-

- Gets the related link text for this Video. -

- -

- - Property name: linkText
- Type: String
- Read only?: no
- Description: The text displayed for the linkURL, limited to - 255 characters. - +

+ Gets the related link text for this Video. +

+ +

+ + Property name: linkText
+ Type: String
+ Read only?: no
+ Description: The text displayed for the linkURL, limited to + 255 characters. +

@@ -1925,18 +1925,18 @@ 

 public void setLinkText(java.lang.String linkText)
-

- Sets the related link text for this Video. -

- -

- - Property name: linkText
- Type: String
- Read only?: no
- Description: The text displayed for the linkURL, limited to - 255 characters. - +

+ Sets the related link text for this Video. +

+ +

+ + Property name: linkText
+ Type: String
+ Read only?: no
+ Description: The text displayed for the linkURL, limited to + 255 characters. +

@@ -1950,20 +1950,20 @@ 

 public java.util.List<java.lang.String> getTags()
-

- Gets the keyword tags for this Video. -

- -

- - Property name: tags
- Type: List
- Read only?: no
- Description: A list of Strings representing the tags - assigned to this Video. Each tag can be not - more than 128 characters, and a video can have - no more than 1200 tags. - +

+ Gets the keyword tags for this Video. +

+ +

+ + Property name: tags
+ Type: List
+ Read only?: no
+ Description: A list of Strings representing the tags + assigned to this Video. Each tag can be not + more than 128 characters, and a video can have + no more than 1200 tags. +

@@ -1978,20 +1978,20 @@ 

 public void setTags(java.util.List<java.lang.String> tags)
-

- Sets the keyword tags for this Video. -

- -

- - Property name: tags
- Type: List
- Read only?: no
- Description: A list of Strings representing the tags - assigned to this Video. Each tag can be not - more than 128 characters, and a video can have - no more than 1200 tags. - +

+ Sets the keyword tags for this Video. +

+ +

+ + Property name: tags
+ Type: List
+ Read only?: no
+ Description: A list of Strings representing the tags + assigned to this Video. Each tag can be not + more than 128 characters, and a video can have + no more than 1200 tags. +

@@ -2005,19 +2005,19 @@ 

 public java.lang.String getVideoStillUrl()
-

- Gets the video still URL for this Video. -

- -

- - Property name: videoStillURL
- Type: String
- Read only?: yes
- Description: The URL to the video still image associated - with this Video. Video stills are 480x360 - pixels. - +

+ Gets the video still URL for this Video. +

+ +

+ + Property name: videoStillURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the video still image associated + with this Video. Video stills are 480x360 + pixels. +

@@ -2032,19 +2032,19 @@ 

 public void setVideoStillUrl(java.lang.String videoStillUrl)
-

- Sets the video still URL for this Video. -

- -

- - Property name: videoStillURL
- Type: String
- Read only?: yes
- Description: The URL to the video still image associated - with this Video. Video stills are 480x360 - pixels. - +

+ Sets the video still URL for this Video. +

+ +

+ + Property name: videoStillURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the video still image associated + with this Video. Video stills are 480x360 + pixels. +

@@ -2058,18 +2058,18 @@ 

 public java.lang.String getThumbnailUrl()
-

- Gets the thumbnail URL for this Video. -

- -

- - Property name: thumbnailURL
- Type: String
- Read only?: yes
- Description: The URL to the thumbnail image associated with - this Video. Thumbnails are 120x90 pixels. - +

+ Gets the thumbnail URL for this Video. +

+ +

+ + Property name: thumbnailURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the thumbnail image associated with + this Video. Thumbnails are 120x90 pixels. +

@@ -2084,18 +2084,18 @@ 

 public void setThumbnailUrl(java.lang.String thumbnailUrl)
-

- Sets the thumbnail URL for this Video. -

- -

- - Property name: thumbnailURL
- Type: String
- Read only?: yes
- Description: The URL to the thumbnail image associated with - this Video. Thumbnails are 120x90 pixels. - +

+ Sets the thumbnail URL for this Video. +

+ +

+ + Property name: thumbnailURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the thumbnail image associated with + this Video. Thumbnails are 120x90 pixels. +

@@ -2109,17 +2109,17 @@ 

 public java.lang.Long getLength()
-

- Gets the length for this Video. -

- -

- - Property name: length
- Type: long
- Read only?: yes
- Description: The length of this video in milliseconds. - +

+ Gets the length for this Video. +

+ +

+ + Property name: length
+ Type: long
+ Read only?: yes
+ Description: The length of this video in milliseconds. +

@@ -2134,17 +2134,17 @@ 

 public void setLength(java.lang.Long length)
-

- Sets the length for this Video. -

- -

- - Property name: length
- Type: long
- Read only?: yes
- Description: The length of this video in milliseconds. - +

+ Sets the length for this Video. +

+ +

+ + Property name: length
+ Type: long
+ Read only?: yes
+ Description: The length of this video in milliseconds. +

@@ -2158,19 +2158,19 @@ 

 public java.util.List<CustomField> getCustomFields()
-

- Gets the custom fields for this Video. -

- -

- - Property name: customFields
- Type: Object
- Read only?: no
- Description: A map of names and values for - custom fields set up for videos in your account. - More information and examples. - +

+ Gets the custom fields for this Video. +

+ +

+ + Property name: customFields
+ Type: Object
+ Read only?: no
+ Description: A map of names and values for + custom fields set up for videos in your account. + More information and examples. +

@@ -2185,19 +2185,19 @@ 

 public void setCustomFields(java.util.List<CustomField> customFields)
-

- Sets the custom fields for this Video. -

- -

- - Property name: customFields
- Type: Object
- Read only?: no
- Description: A map of names and values for - custom fields set up for videos in your account. - More information and examples. - +

+ Sets the custom fields for this Video. +

+ +

+ + Property name: customFields
+ Type: Object
+ Read only?: no
+ Description: A map of names and values for + custom fields set up for videos in your account. + More information and examples. +

@@ -2211,20 +2211,20 @@ 

 public EconomicsEnum getEconomics()
-

- Gets the economics for this Video. -

- -

- - Property name: economics
- Type: Enum
- Read only?: no
- Description: An - EconomicsEnum. - Either FREE or AD_SUPPORTED. AD_SUPPORTED means - that ad requests are enabled for the Video. - +

+ Gets the economics for this Video. +

+ +

+ + Property name: economics
+ Type: Enum
+ Read only?: no
+ Description: An + EconomicsEnum. + Either FREE or AD_SUPPORTED. AD_SUPPORTED means + that ad requests are enabled for the Video. +

@@ -2239,20 +2239,20 @@ 

 public void setEconomics(EconomicsEnum economics)
-

- Sets the economics for this Video. -

- -

- - Property name: economics
- Type: Enum
- Read only?: no
- Description: An - EconomicsEnum. - Either FREE or AD_SUPPORTED. AD_SUPPORTED means - that ad requests are enabled for the Video. - +

+ Sets the economics for this Video. +

+ +

+ + Property name: economics
+ Type: Enum
+ Read only?: no
+ Description: An + EconomicsEnum. + Either FREE or AD_SUPPORTED. AD_SUPPORTED means + that ad requests are enabled for the Video. +

@@ -2266,22 +2266,22 @@ 

 public java.lang.String getAdKeys()
-

- Gets the ad keys for this Video. -

- -

- - Property name: adKeys
- Type: String
- Read only?: no
- Description: A string representing the ad - key/value pairs - assigned to the video. Key/value pairs are - formatted as key=value and are separated by - ampersands (&). For example:
- "adKeys":"category=sports&live=true" - +

+ Gets the ad keys for this Video. +

+ +

+ + Property name: adKeys
+ Type: String
+ Read only?: no
+ Description: A string representing the ad + key/value pairs + assigned to the video. Key/value pairs are + formatted as key=value and are separated by + ampersands (&). For example:
+ "adKeys":"category=sports&live=true" +

@@ -2296,22 +2296,22 @@ 

 public void setAdKeys(java.lang.String adKeys)
-

- Sets the ad keys for this Video. -

- -

- - Property name: adKeys
- Type: String
- Read only?: no
- Description: A string representing the ad - key/value pairs - assigned to the video. Key/value pairs are - formatted as key=value and are separated by - ampersands (&). For example:
- "adKeys":"category=sports&live=true" - +

+ Sets the ad keys for this Video. +

+ +

+ + Property name: adKeys
+ Type: String
+ Read only?: no
+ Description: A string representing the ad + key/value pairs + assigned to the video. Key/value pairs are + formatted as key=value and are separated by + ampersands (&). For example:
+ "adKeys":"category=sports&live=true" +

@@ -2325,18 +2325,18 @@ 

 public java.lang.Boolean getGeoFiltered()
-

- Gets the geo filtered state for this Video. -

- -

- - Property name: geoRestricted
- Type: boolean
- Read only?: no
- Description: True indicates that the video is - geo-restricted. - +

+ Gets the geo filtered state for this Video. +

+ +

+ + Property name: geoRestricted
+ Type: boolean
+ Read only?: no
+ Description: True indicates that the video is + geo-restricted. +

@@ -2351,18 +2351,18 @@ 

 public void setGeoFiltered(java.lang.Boolean geoFiltered)
-

- Sets the geo filtered state for this Video. -

- -

- - Property name: geoRestricted
- Type: boolean
- Read only?: no
- Description: True indicates that the video is - geo-restricted. - +

+ Sets the geo filtered state for this Video. +

+ +

+ + Property name: geoRestricted
+ Type: boolean
+ Read only?: no
+ Description: True indicates that the video is + geo-restricted. +

@@ -2376,20 +2376,20 @@ 

 public java.util.List<GeoFilterCodeEnum> getGeoFilteredCountries()
-

- Gets the geo-filtered countries for this Video. -

- -

- - Property name: geoFilteredCountries
- Type: List
- Read only?: no
- Description: A list of the - ISO-3166 two-letter codes - of the countries to enforce geo-restriction - rules on. Use lowercase for the country codes. - +

+ Gets the geo-filtered countries for this Video. +

+ +

+ + Property name: geoFilteredCountries
+ Type: List
+ Read only?: no
+ Description: A list of the + ISO-3166 two-letter codes + of the countries to enforce geo-restriction + rules on. Use lowercase for the country codes. +

@@ -2404,20 +2404,20 @@ 

 public void setGeoFilteredCountries(java.util.List<GeoFilterCodeEnum> geoFilteredCountries)
-

- Sets the geo-filtered countries for this Video. -

- -

- - Property name: geoFilteredCountries
- Type: List
- Read only?: no
- Description: A list of the - ISO-3166 two-letter codes - of the countries to enforce geo-restriction - rules on. Use lowercase for the country codes. - +

+ Sets the geo-filtered countries for this Video. +

+ +

+ + Property name: geoFilteredCountries
+ Type: List
+ Read only?: no
+ Description: A list of the + ISO-3166 two-letter codes + of the countries to enforce geo-restriction + rules on. Use lowercase for the country codes. +

@@ -2431,21 +2431,21 @@ 

 public java.lang.Boolean getGeoFilteredExclude()
-

- Gets the geo filtered exclude state for this Video. -

- -

- - Property name: geoFilterExclude
- Type: boolean
- Read only?: no
- Description: If true, the video can be viewed in all - countries except those listed in - geoFiltereCountries; if false, the video can be - viewed only in the countries listed in - geoFilteredCountries. - +

+ Gets the geo filtered exclude state for this Video. +

+ +

+ + Property name: geoFilterExclude
+ Type: boolean
+ Read only?: no
+ Description: If true, the video can be viewed in all + countries except those listed in + geoFiltereCountries; if false, the video can be + viewed only in the countries listed in + geoFilteredCountries. +

@@ -2460,21 +2460,21 @@ 

 public void setGeoFilteredExclude(java.lang.Boolean geoFilteredExclude)
-

- Sets the geo filtered exclude state for this Video. -

- -

- - Property name: geoFilterExclude
- Type: boolean
- Read only?: no
- Description: If true, the video can be viewed in all - countries except those listed in - geoFiltereCountries; if false, the video can be - viewed only in the countries listed in - geoFilteredCountries. - +

+ Sets the geo filtered exclude state for this Video. +

+ +

+ + Property name: geoFilterExclude
+ Type: boolean
+ Read only?: no
+ Description: If true, the video can be viewed in all + countries except those listed in + geoFiltereCountries; if false, the video can be + viewed only in the countries listed in + geoFilteredCountries. +

@@ -2488,19 +2488,19 @@ 

 public java.util.List<CuePoint> getCuePoints()
-

- Gets the cue points for this Video. -

- -

- - Property name: cuePoints
- Type: List
- Read only?: no
- Description: A list of the - CuePoints - objects assigned to this Video. - +

+ Gets the cue points for this Video. +

+ +

+ + Property name: cuePoints
+ Type: List
+ Read only?: no
+ Description: A list of the + CuePoints + objects assigned to this Video. +

@@ -2515,19 +2515,19 @@ 

 public void setCuePoints(java.util.List<CuePoint> cuePoints)
-

- Sets the cue points for this Video. -

- -

- - Property name: cuePoints
- Type: List
- Read only?: no
- Description: A list of the - CuePoints - objects assigned to this Video. - +

+ Sets the cue points for this Video. +

+ +

+ + Property name: cuePoints
+ Type: List
+ Read only?: no
+ Description: A list of the + CuePoints + objects assigned to this Video. +

@@ -2541,18 +2541,18 @@ 

 public java.lang.Integer getPlaysTotal()
-

- Gets the plays total count for this Video. -

- -

- - Property name: playsTotal
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played since - its creation. - +

+ Gets the plays total count for this Video. +

+ +

+ + Property name: playsTotal
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played since + its creation. +

@@ -2567,18 +2567,18 @@ 

 public void setPlaysTotal(java.lang.Integer playsTotal)
-

- Sets the plays total count for this Video. -

- -

- - Property name: playsTotal
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played since - its creation. - +

+ Sets the plays total count for this Video. +

+ +

+ + Property name: playsTotal
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played since + its creation. +

@@ -2592,18 +2592,18 @@ 

 public java.lang.Integer getPlaysTrailingWeek()
-

- Gets the plays trailing week count for this Video. -

- -

- - Property name: playsTrailingWeek
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played within - the past seven days, exclusive of today. - +

+ Gets the plays trailing week count for this Video. +

+ +

+ + Property name: playsTrailingWeek
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played within + the past seven days, exclusive of today. +

@@ -2618,18 +2618,18 @@ 

 public void setPlaysTrailingWeek(java.lang.Integer playsTrailingWeek)
-

- Sets the plays trailing week count for this Video. -

- -

- - Property name: playsTrailingWeek
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played within - the past seven days, exclusive of today. - +

+ Sets the plays trailing week count for this Video. +

+ +

+ + Property name: playsTrailingWeek
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played within + the past seven days, exclusive of today. +

@@ -2644,12 +2644,12 @@

public org.json.JSONObject toJson() throws org.json.JSONException
-

- Converts the video into a JSON object suitable for use with the Media API -

- -

- Null values will not be included in the JSON sent to the server. +

+ Converts the video into a JSON object suitable for use with the Media API +

+ +

+ Null values will not be included in the JSON sent to the server.

@@ -2667,8 +2667,8 @@

public org.json.JSONObject toJson(java.util.EnumSet<VideoFieldEnum> includeNullFields) throws org.json.JSONException
-

- Converts the video into a JSON object suitable for use with the Media API +

+ Converts the video into a JSON object suitable for use with the Media API

@@ -2685,9 +2685,9 @@ 

 public org.w3c.dom.Element appendXml(org.w3c.dom.Element root)
-

- Uses the W3C libraries to generate an XML representation of - this object. +

+ Uses the W3C libraries to generate an XML representation of + this object.

diff --git a/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html b/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html index 47cb701b..977e7627 100755 --- a/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html +++ b/bc-catalog-objects/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html @@ -102,13 +102,13 @@

-

The state a video is in.

- -

This enumeration is defined primarily by the Media API documentation for - an ItemStateEnum object: - http://docs.brightcove.com/en/media/#ItemStateEnum. -

-

This may be modified however from the Media API documentation so that it +

The state a video is in.

+ +

This enumeration is defined primarily by the Media API documentation for + an ItemStateEnum object: + http://docs.brightcove.com/en/media/#ItemStateEnum. +

+

This may be modified however from the Media API documentation so that it can also support other interfaces (e.g. batch provisioning).

@@ -143,6 +143,12 @@

INACTIVE +
+            + + +PENDING +
            @@ -170,7 +176,7 @@

values()
-          Returns an array containing the constants of this enum type, in +          Returns an array containing the constants of this enum type, in the order they're declared. @@ -234,6 +240,15 @@

+

+PENDING

+
+public static final ItemStateEnum PENDING
+
+
+
+
+ @@ -249,17 +264,17 @@ 

 public static final ItemStateEnum[] values()
-
Returns an array containing the constants of this enum type, in -the order they're declared. This method may be used to iterate -over the constants as follows: -
-for(ItemStateEnum c : ItemStateEnum.values())
-        System.out.println(c);
+
Returns an array containing the constants of this enum type, in
+the order they're declared.  This method may be used to iterate
+over the constants as follows:
+
+for(ItemStateEnum c : ItemStateEnum.values())
+        System.out.println(c);
 

 

 

 
-
Returns:
an array containing the constants of this enum type, in
+
Returns:
an array containing the constants of this enum type, in
 the order they're declared
@@ -270,16 +285,16 @@ 

 public static ItemStateEnum valueOf(java.lang.String name)
-
Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws: -
java.lang.IllegalArgumentException - if this enum type has no constant +
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
diff --git a/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/Video.java b/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/Video.java index 3412f452..02f9784a 100755 --- a/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/Video.java +++ b/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/Video.java @@ -325,6 +325,9 @@ else if(nodeName.equals("itemState")){ if(ItemStateEnum.INACTIVE.toString().equals(nodeValue)){ itemState = ItemStateEnum.INACTIVE; } + if(ItemStateEnum.PENDING.toString().equals(nodeValue)){ + itemState = ItemStateEnum.PENDING; + } } } else if(nodeName.equals("tags")){ @@ -459,8 +462,11 @@ else if(rootValue.toString().equals("DELETED")){ else if(rootValue.toString().equals("INACTIVE")){ itemState = ItemStateEnum.INACTIVE; } + else if(rootValue.toString().equals("PENDING")){ + itemState = ItemStateEnum.PENDING; + } else{ - throw new JSONException("[ERR] Media API specified invalid value for item state '" + rootValue + "'. Acceptable values are 'ACTIVE', 'DELETED' and 'INACTIVE'."); + throw new JSONException("[ERR] Media API specified invalid value for item state '" + rootValue + "'. Acceptable values are 'ACTIVE', 'DELETED', 'PENDING' and 'INACTIVE'."); } } else if("geoFilterExclude".equals(rootKey)){ @@ -1319,7 +1325,7 @@ public void setReleaseDate(Date releaseDate){ * Read only?: no
* Description: An * ItemStateEnum. - * One of the properties: ACTIVE, INACTIVE, or + * One of the properties: ACTIVE, INACTIVE, PENDING, or * DELETED. You can set this property only to * ACTIVE or INACTIVE; you cannot delete a video * by setting its itemState to DELETED. @@ -1344,7 +1350,7 @@ public ItemStateEnum getItemState(){ * Read only?: no
* Description: An * ItemStateEnum. - * One of the properties: ACTIVE, INACTIVE, or + * One of the properties: ACTIVE, INACTIVE, PENDING, or * DELETED. You can set this property only to * ACTIVE or INACTIVE; you cannot delete a video * by setting its itemState to DELETED. diff --git a/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.java b/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.java index ad89ed1d..9da25844 100755 --- a/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.java +++ b/bc-catalog-objects/src/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.java @@ -14,5 +14,5 @@ * */ public enum ItemStateEnum { - ACTIVE, INACTIVE, DELETED + ACTIVE, INACTIVE, DELETED, PENDING } diff --git a/release-build/javadoc/com/brightcove/commons/catalog/objects/Video.html b/release-build/javadoc/com/brightcove/commons/catalog/objects/Video.html index 79679a97..5997a9c3 100755 --- a/release-build/javadoc/com/brightcove/commons/catalog/objects/Video.html +++ b/release-build/javadoc/com/brightcove/commons/catalog/objects/Video.html @@ -98,22 +98,22 @@

-

- A Video object (the metadata defining a video). -

- -

- This object is defined primarily by the Media API documentation for - a Video object: - http://support.brightcove.com/en/docs/media-api-objects-reference#Video. -

-

- This may be modified however from the Media API documentation so that it - can also support other interfaces (e.g. batch provisioning).

-

- - The Video object is an aggregate of metadata and asset information associated with a video. - +

+ A Video object (the metadata defining a video). +

+ +

+ This object is defined primarily by the Media API documentation for + a Video object: + http://support.brightcove.com/en/docs/media-api-objects-reference#Video. +

+

+ This may be modified however from the Media API documentation so that it + can also support other interfaces (e.g. batch provisioning).

+

+ + The Video object is an aggregate of metadata and asset information associated with a video. +

@@ -138,28 +138,28 @@

Video()
-           +           Default Constructor. Video(org.w3c.dom.Element element)
-           +           Constructs a new video from an XML representation (generated by Videos.toXml()). Video(JSONObject jsonObj)
-           +           Constructor using JSON object. Video(java.lang.String json)
-           +           Constructor using JSON string. @@ -178,8 +178,8 @@

appendXml(org.w3c.dom.Element root)
-           - Uses the W3C libraries to generate an XML representation of +           + Uses the W3C libraries to generate an XML representation of this object. @@ -188,7 +188,7 @@

getAccountId()
-           +           Gets the account id for this Video. @@ -197,7 +197,7 @@

getAdKeys()
-           +           Gets the ad keys for this Video. @@ -206,7 +206,7 @@

getCreationDate()
-           +           Gets the creation date for this Video. @@ -215,7 +215,7 @@

getCuePoints()
-           +           Gets the cue points for this Video. @@ -224,7 +224,7 @@

getCustomFields()
-           +           Gets the custom fields for this Video. @@ -233,7 +233,7 @@

getEconomics()
-           +           Gets the economics for this Video. @@ -242,7 +242,7 @@

getEndDate()
-           +           Gets the end date for this Video. @@ -251,7 +251,7 @@

getFlvUrl()
-           +           Gets the FLV URL for this Video. @@ -260,7 +260,7 @@

getGeoFiltered()
-           +           Gets the geo filtered state for this Video. @@ -269,7 +269,7 @@

getGeoFilteredCountries()
-           +           Gets the geo-filtered countries for this Video. @@ -278,7 +278,7 @@

getGeoFilteredExclude()
-           +           Gets the geo filtered exclude state for this Video. @@ -287,7 +287,7 @@

getId()
-           +           Gets the id for this Video. @@ -296,7 +296,7 @@

getIOSRenditions()
-           +           Gets the iOS renditions for this Video. @@ -305,7 +305,7 @@

getItemState()
-           +           Gets the item state for this Video. @@ -314,7 +314,7 @@

getLastModifiedDate()
-           +           Gets the last modified date for this Video. @@ -323,7 +323,7 @@

getLength()
-           +           Gets the length for this Video. @@ -332,7 +332,7 @@

getLinkText()
-           +           Gets the related link text for this Video. @@ -341,7 +341,7 @@

getLinkUrl()
-           +           Gets the related link URL for this Video. @@ -350,7 +350,7 @@

getLongDescription()
-           +           Gets the long description for this Video. @@ -359,7 +359,7 @@

getName()
-           +           Gets the name (title) for this Video. @@ -368,7 +368,7 @@

getPlaysTotal()
-           +           Gets the plays total count for this Video. @@ -377,7 +377,7 @@

getPlaysTrailingWeek()
-           +           Gets the plays trailing week count for this Video. @@ -386,7 +386,7 @@

getPublishedDate()
-           +           Gets the published date for this Video. @@ -395,7 +395,7 @@

getReferenceId()
-           +           Gets the reference id for this Video. @@ -412,7 +412,7 @@

getRenditions()
-           +           Gets the renditions for this Video. @@ -421,7 +421,7 @@

getShortDescription()
-           +           Gets the short description for this Video. @@ -430,7 +430,7 @@

getStartDate()
-           +           Gets the start date for this Video. @@ -439,7 +439,7 @@

getTags()
-           +           Gets the keyword tags for this Video. @@ -448,7 +448,7 @@

getThumbnailUrl()
-           +           Gets the thumbnail URL for this Video. @@ -457,7 +457,7 @@

getVideoFullLength()
-           +           Gets the full length rendition for this Video. @@ -466,7 +466,7 @@

getVideoStillUrl()
-           +           Gets the video still URL for this Video. @@ -475,7 +475,7 @@

initAll()
-           +           Fully initializes the video object by setting all fields to null @@ -484,7 +484,7 @@

setAccountId(java.lang.Long accountId)
-           +           Sets the account id for this Video. @@ -493,7 +493,7 @@

setAdKeys(java.lang.String adKeys)
-           +           Sets the ad keys for this Video. @@ -502,7 +502,7 @@

setCreationDate(java.util.Date creationDate)
-           +           Sets the creation date for this Video. @@ -511,7 +511,7 @@

setCuePoints(java.util.List<CuePoint> cuePoints)
-           +           Sets the cue points for this Video. @@ -520,7 +520,7 @@

setCustomFields(java.util.List<CustomField> customFields)
-           +           Sets the custom fields for this Video. @@ -529,7 +529,7 @@

setEconomics(EconomicsEnum economics)
-           +           Sets the economics for this Video. @@ -538,7 +538,7 @@

setEndDate(java.util.Date endDate)
-           +           Sets the end date for this Video. @@ -547,7 +547,7 @@

setFlvUrl(java.lang.String flvUrl)
-           +           Sets the FLV URL for this Video. @@ -556,7 +556,7 @@

setGeoFiltered(java.lang.Boolean geoFiltered)
-           +           Sets the geo filtered state for this Video. @@ -565,7 +565,7 @@

setGeoFilteredCountries(java.util.List<GeoFilterCodeEnum> geoFilteredCountries)
-           +           Sets the geo-filtered countries for this Video. @@ -574,7 +574,7 @@

setGeoFilteredExclude(java.lang.Boolean geoFilteredExclude)
-           +           Sets the geo filtered exclude state for this Video. @@ -583,7 +583,7 @@

setId(java.lang.Long id)
-           +           Sets the id for this Video. @@ -592,7 +592,7 @@

setIOSRenditions(java.util.List<iosRendition> renditions)
-           +           Sets the iOS renditions for this Video. @@ -601,7 +601,7 @@

setItemState(ItemStateEnum itemState)
-           +           Sets the item state for this Video. @@ -610,7 +610,7 @@

setLastModifiedDate(java.util.Date lastModifiedDate)
-           +           Sets the last modified date for this Video. @@ -619,7 +619,7 @@

setLength(java.lang.Long length)
-           +           Sets the length for this Video. @@ -628,7 +628,7 @@

setLinkText(java.lang.String linkText)
-           +           Sets the related link text for this Video. @@ -637,7 +637,7 @@

setLinkUrl(java.lang.String linkUrl)
-           +           Sets the related link URL for this Video. @@ -646,7 +646,7 @@

setLongDescription(java.lang.String longDescription)
-           +           Sets the long description for this Video. @@ -655,7 +655,7 @@

setName(java.lang.String name)
-           +           Sets the name (title) for this Video. @@ -664,7 +664,7 @@

setPlaysTotal(java.lang.Integer playsTotal)
-           +           Sets the plays total count for this Video. @@ -673,7 +673,7 @@

setPlaysTrailingWeek(java.lang.Integer playsTrailingWeek)
-           +           Sets the plays trailing week count for this Video. @@ -682,7 +682,7 @@

setPublishedDate(java.util.Date publishedDate)
-           +           Sets the published date for this Video. @@ -691,7 +691,7 @@

setReferenceId(java.lang.String referenceId)
-           +           Sets the reference id for this Video. @@ -700,7 +700,7 @@

setReleaseDate(java.util.Date releaseDate)
-           +           Sets the release date for this Video. @@ -709,7 +709,7 @@

setRenditions(java.util.List<Rendition> renditions)
-           +           Sets the renditions for this Video. @@ -718,7 +718,7 @@

setShortDescription(java.lang.String shortDescription)
-           +           Sets the short description for this Video. @@ -727,7 +727,7 @@

setStartDate(java.util.Date startDate)
-           +           Sets the start date for this Video. @@ -736,7 +736,7 @@

setTags(java.util.List<java.lang.String> tags)
-           +           Sets the keyword tags for this Video. @@ -745,7 +745,7 @@

setThumbnailUrl(java.lang.String thumbnailUrl)
-           +           Sets the thumbnail URL for this Video. @@ -754,7 +754,7 @@

setVideoFullLength(Rendition videoFullLength)
-           +           Sets the full length rendition for this Video. @@ -763,7 +763,7 @@

setVideoStillUrl(java.lang.String videoStillUrl)
-           +           Sets the video still URL for this Video. @@ -772,7 +772,7 @@

toJson()
-           +           Converts the video into a JSON object suitable for use with the Media API @@ -781,7 +781,7 @@

toJson(java.util.EnumSet<VideoFieldEnum> includeNullFields)
-           +           Converts the video into a JSON object suitable for use with the Media API @@ -820,13 +820,13 @@ 

 public Video()
-

- Default Constructor. -

- -

- All fields set to null to start - required fields must be set before - calling Write Media API. +

+ Default Constructor. +

+ +

+ All fields set to null to start - required fields must be set before + calling Write Media API.

@@ -838,14 +838,14 @@

public Video(java.lang.String json) throws JSONException
-

- Constructor using JSON string. -

- -

- Given a JSON string from the Media API, attempts to construct a new - Video object and fill out all of the fields defined. All other - fields will be null. +

+ Constructor using JSON string. +

+ +

+ Given a JSON string from the Media API, attempts to construct a new + Video object and fill out all of the fields defined. All other + fields will be null.

@@ -861,14 +861,14 @@

public Video(JSONObject jsonObj) throws JSONException
-

- Constructor using JSON object. -

- -

- Given a JSON object from the Media API, attempts to construct a new - Video object and fill out all of the fields defined. All other - fields will be null. +

+ Constructor using JSON object. +

+ +

+ Given a JSON object from the Media API, attempts to construct a new + Video object and fill out all of the fields defined. All other + fields will be null.

@@ -883,8 +883,8 @@ 

 public Video(org.w3c.dom.Element element)
-

- Constructs a new video from an XML representation (generated by Videos.toXml()). +

+ Constructs a new video from an XML representation (generated by Videos.toXml()).

@@ -906,8 +906,8 @@ 

 public void initAll()
-

- Fully initializes the video object by setting all fields to null +

+ Fully initializes the video object by setting all fields to null

@@ -921,19 +921,19 @@ 

 public java.lang.String getName()
-

- Gets the name (title) for this Video. -

- -

- - Property name: name
- Type: String
- Read only?: no
- Description: The title of the Video, limited to 255 - characters. The name is a required property - when you create a video. - +

+ Gets the name (title) for this Video. +

+ +

+ + Property name: name
+ Type: String
+ Read only?: no
+ Description: The title of the Video, limited to 255 + characters. The name is a required property + when you create a video. +

@@ -948,19 +948,19 @@ 

 public void setName(java.lang.String name)
-

- Sets the name (title) for this Video. -

- -

- - Property name: name
- Type: String
- Read only?: no
- Description: The title of the Video, limited to 255 - characters. The name is a required property - when you create a video. - +

+ Sets the name (title) for this Video. +

+ +

+ + Property name: name
+ Type: String
+ Read only?: no
+ Description: The title of the Video, limited to 255 + characters. The name is a required property + when you create a video. +

@@ -974,19 +974,19 @@ 

 public java.lang.Long getId()
-

- Gets the id for this Video. -

- -

- - Property name: id
- Type: long
- Read only?: yes
- Description: A number that uniquely identifies this Video, - assigned by Brightcove when the Video is - created. - +

+ Gets the id for this Video. +

+ +

+ + Property name: id
+ Type: long
+ Read only?: yes
+ Description: A number that uniquely identifies this Video, + assigned by Brightcove when the Video is + created. +

@@ -1001,19 +1001,19 @@ 

 public void setId(java.lang.Long id)
-

- Sets the id for this Video. -

- -

- - Property name: id
- Type: long
- Read only?: yes
- Description: A number that uniquely identifies this Video, - assigned by Brightcove when the Video is - created. - +

+ Sets the id for this Video. +

+ +

+ + Property name: id
+ Type: long
+ Read only?: yes
+ Description: A number that uniquely identifies this Video, + assigned by Brightcove when the Video is + created. +

@@ -1027,24 +1027,24 @@ 

 public java.lang.String getReferenceId()
-

- Gets the reference id for this Video. -

- -

- - Property name: referenceId
- Type: String
- Read only?: no
- Description: A user-specified id that uniquely identifies - the Video, limited to 150 characters. A - referenceId can be used as a foreign-key to - identify this video in another system. Note - that that the find_videos_by_reference_ids - method cannot handle a referenceId that contain - commas, so you may want to avoid using commas - in referenceId values. - +

+ Gets the reference id for this Video. +

+ +

+ + Property name: referenceId
+ Type: String
+ Read only?: no
+ Description: A user-specified id that uniquely identifies + the Video, limited to 150 characters. A + referenceId can be used as a foreign-key to + identify this video in another system. Note + that that the find_videos_by_reference_ids + method cannot handle a referenceId that contain + commas, so you may want to avoid using commas + in referenceId values. +

@@ -1059,24 +1059,24 @@ 

 public void setReferenceId(java.lang.String referenceId)
-

- Sets the reference id for this Video. -

- -

- - Property name: referenceId
- Type: String
- Read only?: no
- Description: A user-specified id that uniquely identifies - the Video, limited to 150 characters. A - referenceId can be used as a foreign-key to - identify this video in another system. Note - that that the find_videos_by_reference_ids - method cannot handle a referenceId that contain - commas, so you may want to avoid using commas - in referenceId values. - +

+ Sets the reference id for this Video. +

+ +

+ + Property name: referenceId
+ Type: String
+ Read only?: no
+ Description: A user-specified id that uniquely identifies + the Video, limited to 150 characters. A + referenceId can be used as a foreign-key to + identify this video in another system. Note + that that the find_videos_by_reference_ids + method cannot handle a referenceId that contain + commas, so you may want to avoid using commas + in referenceId values. +

@@ -1090,19 +1090,19 @@ 

 public java.lang.Long getAccountId()
-

- Gets the account id for this Video. -

- -

- - Property name: accountId
- Type: long
- Read only?: yes
- Description: A number, assigned by Brightcove, that uniquely - identifies the account to which the Video - belongs. - +

+ Gets the account id for this Video. +

+ +

+ + Property name: accountId
+ Type: long
+ Read only?: yes
+ Description: A number, assigned by Brightcove, that uniquely + identifies the account to which the Video + belongs. +

@@ -1117,19 +1117,19 @@ 

 public void setAccountId(java.lang.Long accountId)
-

- Sets the account id for this Video. -

- -

- - Property name: accountId
- Type: long
- Read only?: yes
- Description: A number, assigned by Brightcove, that uniquely - identifies the account to which the Video - belongs. - +

+ Sets the account id for this Video. +

+ +

+ + Property name: accountId
+ Type: long
+ Read only?: yes
+ Description: A number, assigned by Brightcove, that uniquely + identifies the account to which the Video + belongs. +

@@ -1143,19 +1143,19 @@ 

 public java.lang.String getShortDescription()
-

- Gets the short description for this Video. -

- -

- - Property name: shortDescription
- Type: String
- Read only?: no
- Description: A short description describing the Video, - limited to 250 characters. The shortDescription - is a required property when you create a video. - +

+ Gets the short description for this Video. +

+ +

+ + Property name: shortDescription
+ Type: String
+ Read only?: no
+ Description: A short description describing the Video, + limited to 250 characters. The shortDescription + is a required property when you create a video. +

@@ -1170,19 +1170,19 @@ 

 public void setShortDescription(java.lang.String shortDescription)
-

- Sets the short description for this Video. -

- -

- - Property name: shortDescription
- Type: String
- Read only?: no
- Description: A short description describing the Video, - limited to 250 characters. The shortDescription - is a required property when you create a video. - +

+ Sets the short description for this Video. +

+ +

+ + Property name: shortDescription
+ Type: String
+ Read only?: no
+ Description: A short description describing the Video, + limited to 250 characters. The shortDescription + is a required property when you create a video. +

@@ -1196,18 +1196,18 @@ 

 public java.lang.String getLongDescription()
-

- Gets the long description for this Video. -

- -

- - Property name: longDescription
- Type: String
- Read only?: no
- Description: A longer description of this Video, limited to - 5000 characters. - +

+ Gets the long description for this Video. +

+ +

+ + Property name: longDescription
+ Type: String
+ Read only?: no
+ Description: A longer description of this Video, limited to + 5000 characters. +

@@ -1222,18 +1222,18 @@ 

 public void setLongDescription(java.lang.String longDescription)
-

- Sets the long description for this Video. -

- -

- - Property name: longDescription
- Type: String
- Read only?: no
- Description: A longer description of this Video, limited to - 5000 characters. - +

+ Sets the long description for this Video. +

+ +

+ + Property name: longDescription
+ Type: String
+ Read only?: no
+ Description: A longer description of this Video, limited to + 5000 characters. +

@@ -1247,23 +1247,23 @@ 

 public java.lang.String getFlvUrl()
-

- Gets the FLV URL for this Video. -

- -

- - Property name: FLVURL
- Type: String
- Read only?: yes
- Description: The URL of the video file for this Video. Note - that this property can be accessed with the - Media API only with a special read or write - token. This property applies, no matter whether - the video's encoding is FLV (VP6) or MP4 - (H.264). See - Accessing Video Content with the Media API. - +

+ Gets the FLV URL for this Video. +

+ +

+ + Property name: FLVURL
+ Type: String
+ Read only?: yes
+ Description: The URL of the video file for this Video. Note + that this property can be accessed with the + Media API only with a special read or write + token. This property applies, no matter whether + the video's encoding is FLV (VP6) or MP4 + (H.264). See + Accessing Video Content with the Media API. +

@@ -1278,23 +1278,23 @@ 

 public void setFlvUrl(java.lang.String flvUrl)
-

- Sets the FLV URL for this Video. -

- -

- - Property name: FLVURL
- Type: String
- Read only?: yes
- Description: The URL of the video file for this Video. Note - that this property can be accessed with the - Media API only with a special read or write - token. This property applies, no matter whether - the video's encoding is FLV (VP6) or MP4 - (H.264). See - Accessing Video Content with the Media API. - +

+ Sets the FLV URL for this Video. +

+ +

+ + Property name: FLVURL
+ Type: String
+ Read only?: yes
+ Description: The URL of the video file for this Video. Note + that this property can be accessed with the + Media API only with a special read or write + token. This property applies, no matter whether + the video's encoding is FLV (VP6) or MP4 + (H.264). See + Accessing Video Content with the Media API. +

@@ -1308,25 +1308,25 @@ 

 public java.util.List<Rendition> getRenditions()
-

- Gets the renditions for this Video. -

- -

- - Property name: renditions
- Type: Array
- Read only?: no
- Description: An array of - Renditions - that represent the multi-bitrate streaming - renditions available for this Video. A Video - should have not more than 10 Renditions. Note - that this property can be accessed with the - Media API only with a special read or write - token. See - Accessing Video Content with the Media API. - +

+ Gets the renditions for this Video. +

+ +

+ + Property name: renditions
+ Type: Array
+ Read only?: no
+ Description: An array of + Renditions + that represent the multi-bitrate streaming + renditions available for this Video. A Video + should have not more than 10 Renditions. Note + that this property can be accessed with the + Media API only with a special read or write + token. See + Accessing Video Content with the Media API. +

@@ -1341,25 +1341,25 @@ 

 public void setRenditions(java.util.List<Rendition> renditions)
-

- Sets the renditions for this Video. -

- -

- - Property name: renditions
- Type: Array
- Read only?: no
- Description: An array of - Renditions - that represent the multi-bitrate streaming - renditions available for this Video. A Video - should have not more than 10 Renditions. Note - that this property can be accessed with the - Media API only with a special read or write - token. See - Accessing Video Content with the Media API. - +

+ Sets the renditions for this Video. +

+ +

+ + Property name: renditions
+ Type: Array
+ Read only?: no
+ Description: An array of + Renditions + that represent the multi-bitrate streaming + renditions available for this Video. A Video + should have not more than 10 Renditions. Note + that this property can be accessed with the + Media API only with a special read or write + token. See + Accessing Video Content with the Media API. +

@@ -1373,17 +1373,17 @@ 

 public java.util.List<Rendition> getIOSRenditions()
-

- Gets the iOS renditions for this Video. -

- -

- - Property name: iosRenditions
- Type: Array
- Read only?: no
- Description: - +

+ Gets the iOS renditions for this Video. +

+ +

+ + Property name: iosRenditions
+ Type: Array
+ Read only?: no
+ Description: +

@@ -1398,17 +1398,17 @@ 

 public void setIOSRenditions(java.util.List<iosRendition> renditions)
-

- Sets the iOS renditions for this Video. -

- -

- - Property name: iosRenditions
- Type: Array
- Read only?: no
- Description: - +

+ Sets the iOS renditions for this Video. +

+ +

+ + Property name: iosRenditions
+ Type: Array
+ Read only?: no
+ Description: +

@@ -1422,23 +1422,23 @@ 

 public Rendition getVideoFullLength()
-

- Gets the full length rendition for this Video. -

- -

- - Property name: videoFullLength
- Type: Rendition
- Read only?: no
- Description: A single - Rendition - that represents the the video file for the - Video. Note that this property can be accessed - with the Media API only with a special read or - write token. See - Accessing Video Content with the Media API. - +

+ Gets the full length rendition for this Video. +

+ +

+ + Property name: videoFullLength
+ Type: Rendition
+ Read only?: no
+ Description: A single + Rendition + that represents the the video file for the + Video. Note that this property can be accessed + with the Media API only with a special read or + write token. See + Accessing Video Content with the Media API. +

@@ -1453,23 +1453,23 @@ 

 public void setVideoFullLength(Rendition videoFullLength)
-

- Sets the full length rendition for this Video. -

- -

- - Property name: videoFullLength
- Type: Rendition
- Read only?: no
- Description: A single - Rendition - that represents the the video file for the - Video. Note that this property can be accessed - with the Media API only with a special read or - write token. See - Accessing Video Content with the Media API. - +

+ Sets the full length rendition for this Video. +

+ +

+ + Property name: videoFullLength
+ Type: Rendition
+ Read only?: no
+ Description: A single + Rendition + that represents the the video file for the + Video. Note that this property can be accessed + with the Media API only with a special read or + write token. See + Accessing Video Content with the Media API. +

@@ -1483,19 +1483,19 @@ 

 public java.util.Date getCreationDate()
-

- Gets the creation date for this Video. -

- -

- - Property name: creationDate
- Type: Date
- Read only?: yes
- Description: The date this Video was created, represented as - the number of milliseconds since the UNIX - epoch. - +

+ Gets the creation date for this Video. +

+ +

+ + Property name: creationDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was created, represented as + the number of milliseconds since the UNIX + epoch. +

@@ -1510,19 +1510,19 @@ 

 public void setCreationDate(java.util.Date creationDate)
-

- Sets the creation date for this Video. -

- -

- - Property name: creationDate
- Type: Date
- Read only?: yes
- Description: The date this Video was created, represented as - the number of milliseconds since the UNIX - epoch. - +

+ Sets the creation date for this Video. +

+ +

+ + Property name: creationDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was created, represented as + the number of milliseconds since the UNIX + epoch. +

@@ -1536,19 +1536,19 @@ 

 public java.util.Date getPublishedDate()
-

- Gets the published date for this Video. -

- -

- - Property name: publishedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last made active, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Gets the published date for this Video. +

+ +

+ + Property name: publishedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last made active, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1563,19 +1563,19 @@ 

 public void setPublishedDate(java.util.Date publishedDate)
-

- Sets the published date for this Video. -

- -

- - Property name: publishedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last made active, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Sets the published date for this Video. +

+ +

+ + Property name: publishedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last made active, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1589,19 +1589,19 @@ 

 public java.util.Date getLastModifiedDate()
-

- Gets the last modified date for this Video. -

- -

- - Property name: lastModifiedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last modified, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Gets the last modified date for this Video. +

+ +

+ + Property name: lastModifiedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last modified, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1616,19 +1616,19 @@ 

 public void setLastModifiedDate(java.util.Date lastModifiedDate)
-

- Sets the last modified date for this Video. -

- -

- - Property name: lastModifiedDate
- Type: Date
- Read only?: yes
- Description: The date this Video was last modified, - represented as the number of milliseconds since - the UNIX epoch. - +

+ Sets the last modified date for this Video. +

+ +

+ + Property name: lastModifiedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last modified, + represented as the number of milliseconds since + the UNIX epoch. +

@@ -1642,12 +1642,12 @@ 

 public java.util.Date getReleaseDate()
-

Gets the release date for this Video.

- -

- - undocumented - +

Gets the release date for this Video.

+ +

+ + undocumented +

@@ -1662,14 +1662,14 @@ 

 public void setReleaseDate(java.util.Date releaseDate)
-

- Sets the release date for this Video. -

- -

- - undocumented - +

+ Sets the release date for this Video. +

+ +

+ + undocumented +

@@ -1683,22 +1683,22 @@ 

 public ItemStateEnum getItemState()
-

- Gets the item state for this Video. -

- -

- - Property name: itemState
- Type: Enum
- Read only?: no
- Description: An - ItemStateEnum. - One of the properties: ACTIVE, INACTIVE, or - DELETED. You can set this property only to - ACTIVE or INACTIVE; you cannot delete a video - by setting its itemState to DELETED. - +

+ Gets the item state for this Video. +

+ +

+ + Property name: itemState
+ Type: Enum
+ Read only?: no
+ Description: An + ItemStateEnum. + One of the properties: ACTIVE, INACTIVE, PENDING, or + DELETED. You can set this property only to + ACTIVE or INACTIVE; you cannot delete a video + by setting its itemState to DELETED. +

@@ -1713,22 +1713,22 @@ 

 public void setItemState(ItemStateEnum itemState)
-

- Sets the item state for this Video. -

- -

- - Property name: itemState
- Type: Enum
- Read only?: no
- Description: An - ItemStateEnum. - One of the properties: ACTIVE, INACTIVE, or - DELETED. You can set this property only to - ACTIVE or INACTIVE; you cannot delete a video - by setting its itemState to DELETED. - +

+ Sets the item state for this Video. +

+ +

+ + Property name: itemState
+ Type: Enum
+ Read only?: no
+ Description: An + ItemStateEnum. + One of the properties: ACTIVE, INACTIVE, PENDING, or + DELETED. You can set this property only to + ACTIVE or INACTIVE; you cannot delete a video + by setting its itemState to DELETED. +

@@ -1742,19 +1742,19 @@ 

 public java.util.Date getStartDate()
-

- Gets the start date for this Video. -

- -

- - Property name: startDate
- Type: Date
- Read only?: no
- Description: The first date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Gets the start date for this Video. +

+ +

+ + Property name: startDate
+ Type: Date
+ Read only?: no
+ Description: The first date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1769,19 +1769,19 @@ 

 public void setStartDate(java.util.Date startDate)
-

- Sets the start date for this Video. -

- -

- - Property name: startDate
- Type: Date
- Read only?: no
- Description: The first date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Sets the start date for this Video. +

+ +

+ + Property name: startDate
+ Type: Date
+ Read only?: no
+ Description: The first date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1795,19 +1795,19 @@ 

 public java.util.Date getEndDate()
-

- Gets the end date for this Video. -

- -

- - Property name: endDate
- Type: Date
- Read only?: no
- Description: The last date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Gets the end date for this Video. +

+ +

+ + Property name: endDate
+ Type: Date
+ Read only?: no
+ Description: The last date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1822,19 +1822,19 @@ 

 public void setEndDate(java.util.Date endDate)
-

- Sets the end date for this Video. -

- -

- - Property name: endDate
- Type: Date
- Read only?: no
- Description: The last date this Video is available to be - played, represented as the number of - milliseconds since the UNIX epoch. - +

+ Sets the end date for this Video. +

+ +

+ + Property name: endDate
+ Type: Date
+ Read only?: no
+ Description: The last date this Video is available to be + played, represented as the number of + milliseconds since the UNIX epoch. +

@@ -1848,18 +1848,18 @@ 

 public java.lang.String getLinkUrl()
-

- Gets the related link URL for this Video. -

- -

- - Property name: linkURL
- Type: String
- Read only?: no
- Description: An optional URL to a related item, limited to - 255 characters. - +

+ Gets the related link URL for this Video. +

+ +

+ + Property name: linkURL
+ Type: String
+ Read only?: no
+ Description: An optional URL to a related item, limited to + 255 characters. +

@@ -1874,18 +1874,18 @@ 

 public void setLinkUrl(java.lang.String linkUrl)
-

- Sets the related link URL for this Video. -

- -

- - Property name: linkURL
- Type: String
- Read only?: no
- Description: An optional URL to a related item, limited to - 255 characters. - +

+ Sets the related link URL for this Video. +

+ +

+ + Property name: linkURL
+ Type: String
+ Read only?: no
+ Description: An optional URL to a related item, limited to + 255 characters. +

@@ -1899,18 +1899,18 @@ 

 public java.lang.String getLinkText()
-

- Gets the related link text for this Video. -

- -

- - Property name: linkText
- Type: String
- Read only?: no
- Description: The text displayed for the linkURL, limited to - 255 characters. - +

+ Gets the related link text for this Video. +

+ +

+ + Property name: linkText
+ Type: String
+ Read only?: no
+ Description: The text displayed for the linkURL, limited to + 255 characters. +

@@ -1925,18 +1925,18 @@ 

 public void setLinkText(java.lang.String linkText)
-

- Sets the related link text for this Video. -

- -

- - Property name: linkText
- Type: String
- Read only?: no
- Description: The text displayed for the linkURL, limited to - 255 characters. - +

+ Sets the related link text for this Video. +

+ +

+ + Property name: linkText
+ Type: String
+ Read only?: no
+ Description: The text displayed for the linkURL, limited to + 255 characters. +

@@ -1950,20 +1950,20 @@ 

 public java.util.List<java.lang.String> getTags()
-

- Gets the keyword tags for this Video. -

- -

- - Property name: tags
- Type: List
- Read only?: no
- Description: A list of Strings representing the tags - assigned to this Video. Each tag can be not - more than 128 characters, and a video can have - no more than 1200 tags. - +

+ Gets the keyword tags for this Video. +

+ +

+ + Property name: tags
+ Type: List
+ Read only?: no
+ Description: A list of Strings representing the tags + assigned to this Video. Each tag can be not + more than 128 characters, and a video can have + no more than 1200 tags. +

@@ -1978,20 +1978,20 @@ 

 public void setTags(java.util.List<java.lang.String> tags)
-

- Sets the keyword tags for this Video. -

- -

- - Property name: tags
- Type: List
- Read only?: no
- Description: A list of Strings representing the tags - assigned to this Video. Each tag can be not - more than 128 characters, and a video can have - no more than 1200 tags. - +

+ Sets the keyword tags for this Video. +

+ +

+ + Property name: tags
+ Type: List
+ Read only?: no
+ Description: A list of Strings representing the tags + assigned to this Video. Each tag can be not + more than 128 characters, and a video can have + no more than 1200 tags. +

@@ -2005,19 +2005,19 @@ 

 public java.lang.String getVideoStillUrl()
-

- Gets the video still URL for this Video. -

- -

- - Property name: videoStillURL
- Type: String
- Read only?: yes
- Description: The URL to the video still image associated - with this Video. Video stills are 480x360 - pixels. - +

+ Gets the video still URL for this Video. +

+ +

+ + Property name: videoStillURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the video still image associated + with this Video. Video stills are 480x360 + pixels. +

@@ -2032,19 +2032,19 @@ 

 public void setVideoStillUrl(java.lang.String videoStillUrl)
-

- Sets the video still URL for this Video. -

- -

- - Property name: videoStillURL
- Type: String
- Read only?: yes
- Description: The URL to the video still image associated - with this Video. Video stills are 480x360 - pixels. - +

+ Sets the video still URL for this Video. +

+ +

+ + Property name: videoStillURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the video still image associated + with this Video. Video stills are 480x360 + pixels. +

@@ -2058,18 +2058,18 @@ 

 public java.lang.String getThumbnailUrl()
-

- Gets the thumbnail URL for this Video. -

- -

- - Property name: thumbnailURL
- Type: String
- Read only?: yes
- Description: The URL to the thumbnail image associated with - this Video. Thumbnails are 120x90 pixels. - +

+ Gets the thumbnail URL for this Video. +

+ +

+ + Property name: thumbnailURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the thumbnail image associated with + this Video. Thumbnails are 120x90 pixels. +

@@ -2084,18 +2084,18 @@ 

 public void setThumbnailUrl(java.lang.String thumbnailUrl)
-

- Sets the thumbnail URL for this Video. -

- -

- - Property name: thumbnailURL
- Type: String
- Read only?: yes
- Description: The URL to the thumbnail image associated with - this Video. Thumbnails are 120x90 pixels. - +

+ Sets the thumbnail URL for this Video. +

+ +

+ + Property name: thumbnailURL
+ Type: String
+ Read only?: yes
+ Description: The URL to the thumbnail image associated with + this Video. Thumbnails are 120x90 pixels. +

@@ -2109,17 +2109,17 @@ 

 public java.lang.Long getLength()
-

- Gets the length for this Video. -

- -

- - Property name: length
- Type: long
- Read only?: yes
- Description: The length of this video in milliseconds. - +

+ Gets the length for this Video. +

+ +

+ + Property name: length
+ Type: long
+ Read only?: yes
+ Description: The length of this video in milliseconds. +

@@ -2134,17 +2134,17 @@ 

 public void setLength(java.lang.Long length)
-

- Sets the length for this Video. -

- -

- - Property name: length
- Type: long
- Read only?: yes
- Description: The length of this video in milliseconds. - +

+ Sets the length for this Video. +

+ +

+ + Property name: length
+ Type: long
+ Read only?: yes
+ Description: The length of this video in milliseconds. +

@@ -2158,19 +2158,19 @@ 

 public java.util.List<CustomField> getCustomFields()
-

- Gets the custom fields for this Video. -

- -

- - Property name: customFields
- Type: Object
- Read only?: no
- Description: A map of names and values for - custom fields set up for videos in your account. - More information and examples. - +

+ Gets the custom fields for this Video. +

+ +

+ + Property name: customFields
+ Type: Object
+ Read only?: no
+ Description: A map of names and values for + custom fields set up for videos in your account. + More information and examples. +

@@ -2185,19 +2185,19 @@ 

 public void setCustomFields(java.util.List<CustomField> customFields)
-

- Sets the custom fields for this Video. -

- -

- - Property name: customFields
- Type: Object
- Read only?: no
- Description: A map of names and values for - custom fields set up for videos in your account. - More information and examples. - +

+ Sets the custom fields for this Video. +

+ +

+ + Property name: customFields
+ Type: Object
+ Read only?: no
+ Description: A map of names and values for + custom fields set up for videos in your account. + More information and examples. +

@@ -2211,20 +2211,20 @@ 

 public EconomicsEnum getEconomics()
-

- Gets the economics for this Video. -

- -

- - Property name: economics
- Type: Enum
- Read only?: no
- Description: An - EconomicsEnum. - Either FREE or AD_SUPPORTED. AD_SUPPORTED means - that ad requests are enabled for the Video. - +

+ Gets the economics for this Video. +

+ +

+ + Property name: economics
+ Type: Enum
+ Read only?: no
+ Description: An + EconomicsEnum. + Either FREE or AD_SUPPORTED. AD_SUPPORTED means + that ad requests are enabled for the Video. +

@@ -2239,20 +2239,20 @@ 

 public void setEconomics(EconomicsEnum economics)
-

- Sets the economics for this Video. -

- -

- - Property name: economics
- Type: Enum
- Read only?: no
- Description: An - EconomicsEnum. - Either FREE or AD_SUPPORTED. AD_SUPPORTED means - that ad requests are enabled for the Video. - +

+ Sets the economics for this Video. +

+ +

+ + Property name: economics
+ Type: Enum
+ Read only?: no
+ Description: An + EconomicsEnum. + Either FREE or AD_SUPPORTED. AD_SUPPORTED means + that ad requests are enabled for the Video. +

@@ -2266,22 +2266,22 @@ 

 public java.lang.String getAdKeys()
-

- Gets the ad keys for this Video. -

- -

- - Property name: adKeys
- Type: String
- Read only?: no
- Description: A string representing the ad - key/value pairs - assigned to the video. Key/value pairs are - formatted as key=value and are separated by - ampersands (&). For example:
- "adKeys":"category=sports&live=true" - +

+ Gets the ad keys for this Video. +

+ +

+ + Property name: adKeys
+ Type: String
+ Read only?: no
+ Description: A string representing the ad + key/value pairs + assigned to the video. Key/value pairs are + formatted as key=value and are separated by + ampersands (&). For example:
+ "adKeys":"category=sports&live=true" +

@@ -2296,22 +2296,22 @@ 

 public void setAdKeys(java.lang.String adKeys)
-

- Sets the ad keys for this Video. -

- -

- - Property name: adKeys
- Type: String
- Read only?: no
- Description: A string representing the ad - key/value pairs - assigned to the video. Key/value pairs are - formatted as key=value and are separated by - ampersands (&). For example:
- "adKeys":"category=sports&live=true" - +

+ Sets the ad keys for this Video. +

+ +

+ + Property name: adKeys
+ Type: String
+ Read only?: no
+ Description: A string representing the ad + key/value pairs + assigned to the video. Key/value pairs are + formatted as key=value and are separated by + ampersands (&). For example:
+ "adKeys":"category=sports&live=true" +

@@ -2325,18 +2325,18 @@ 

 public java.lang.Boolean getGeoFiltered()
-

- Gets the geo filtered state for this Video. -

- -

- - Property name: geoRestricted
- Type: boolean
- Read only?: no
- Description: True indicates that the video is - geo-restricted. - +

+ Gets the geo filtered state for this Video. +

+ +

+ + Property name: geoRestricted
+ Type: boolean
+ Read only?: no
+ Description: True indicates that the video is + geo-restricted. +

@@ -2351,18 +2351,18 @@ 

 public void setGeoFiltered(java.lang.Boolean geoFiltered)
-

- Sets the geo filtered state for this Video. -

- -

- - Property name: geoRestricted
- Type: boolean
- Read only?: no
- Description: True indicates that the video is - geo-restricted. - +

+ Sets the geo filtered state for this Video. +

+ +

+ + Property name: geoRestricted
+ Type: boolean
+ Read only?: no
+ Description: True indicates that the video is + geo-restricted. +

@@ -2376,20 +2376,20 @@ 

 public java.util.List<GeoFilterCodeEnum> getGeoFilteredCountries()
-

- Gets the geo-filtered countries for this Video. -

- -

- - Property name: geoFilteredCountries
- Type: List
- Read only?: no
- Description: A list of the - ISO-3166 two-letter codes - of the countries to enforce geo-restriction - rules on. Use lowercase for the country codes. - +

+ Gets the geo-filtered countries for this Video. +

+ +

+ + Property name: geoFilteredCountries
+ Type: List
+ Read only?: no
+ Description: A list of the + ISO-3166 two-letter codes + of the countries to enforce geo-restriction + rules on. Use lowercase for the country codes. +

@@ -2404,20 +2404,20 @@ 

 public void setGeoFilteredCountries(java.util.List<GeoFilterCodeEnum> geoFilteredCountries)
-

- Sets the geo-filtered countries for this Video. -

- -

- - Property name: geoFilteredCountries
- Type: List
- Read only?: no
- Description: A list of the - ISO-3166 two-letter codes - of the countries to enforce geo-restriction - rules on. Use lowercase for the country codes. - +

+ Sets the geo-filtered countries for this Video. +

+ +

+ + Property name: geoFilteredCountries
+ Type: List
+ Read only?: no
+ Description: A list of the + ISO-3166 two-letter codes + of the countries to enforce geo-restriction + rules on. Use lowercase for the country codes. +

@@ -2431,21 +2431,21 @@ 

 public java.lang.Boolean getGeoFilteredExclude()
-

- Gets the geo filtered exclude state for this Video. -

- -

- - Property name: geoFilterExclude
- Type: boolean
- Read only?: no
- Description: If true, the video can be viewed in all - countries except those listed in - geoFiltereCountries; if false, the video can be - viewed only in the countries listed in - geoFilteredCountries. - +

+ Gets the geo filtered exclude state for this Video. +

+ +

+ + Property name: geoFilterExclude
+ Type: boolean
+ Read only?: no
+ Description: If true, the video can be viewed in all + countries except those listed in + geoFiltereCountries; if false, the video can be + viewed only in the countries listed in + geoFilteredCountries. +

@@ -2460,21 +2460,21 @@ 

 public void setGeoFilteredExclude(java.lang.Boolean geoFilteredExclude)
-

- Sets the geo filtered exclude state for this Video. -

- -

- - Property name: geoFilterExclude
- Type: boolean
- Read only?: no
- Description: If true, the video can be viewed in all - countries except those listed in - geoFiltereCountries; if false, the video can be - viewed only in the countries listed in - geoFilteredCountries. - +

+ Sets the geo filtered exclude state for this Video. +

+ +

+ + Property name: geoFilterExclude
+ Type: boolean
+ Read only?: no
+ Description: If true, the video can be viewed in all + countries except those listed in + geoFiltereCountries; if false, the video can be + viewed only in the countries listed in + geoFilteredCountries. +

@@ -2488,19 +2488,19 @@ 

 public java.util.List<CuePoint> getCuePoints()
-

- Gets the cue points for this Video. -

- -

- - Property name: cuePoints
- Type: List
- Read only?: no
- Description: A list of the - CuePoints - objects assigned to this Video. - +

+ Gets the cue points for this Video. +

+ +

+ + Property name: cuePoints
+ Type: List
+ Read only?: no
+ Description: A list of the + CuePoints + objects assigned to this Video. +

@@ -2515,19 +2515,19 @@ 

 public void setCuePoints(java.util.List<CuePoint> cuePoints)
-

- Sets the cue points for this Video. -

- -

- - Property name: cuePoints
- Type: List
- Read only?: no
- Description: A list of the - CuePoints - objects assigned to this Video. - +

+ Sets the cue points for this Video. +

+ +

+ + Property name: cuePoints
+ Type: List
+ Read only?: no
+ Description: A list of the + CuePoints + objects assigned to this Video. +

@@ -2541,18 +2541,18 @@ 

 public java.lang.Integer getPlaysTotal()
-

- Gets the plays total count for this Video. -

- -

- - Property name: playsTotal
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played since - its creation. - +

+ Gets the plays total count for this Video. +

+ +

+ + Property name: playsTotal
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played since + its creation. +

@@ -2567,18 +2567,18 @@ 

 public void setPlaysTotal(java.lang.Integer playsTotal)
-

- Sets the plays total count for this Video. -

- -

- - Property name: playsTotal
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played since - its creation. - +

+ Sets the plays total count for this Video. +

+ +

+ + Property name: playsTotal
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played since + its creation. +

@@ -2592,18 +2592,18 @@ 

 public java.lang.Integer getPlaysTrailingWeek()
-

- Gets the plays trailing week count for this Video. -

- -

- - Property name: playsTrailingWeek
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played within - the past seven days, exclusive of today. - +

+ Gets the plays trailing week count for this Video. +

+ +

+ + Property name: playsTrailingWeek
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played within + the past seven days, exclusive of today. +

@@ -2618,18 +2618,18 @@ 

 public void setPlaysTrailingWeek(java.lang.Integer playsTrailingWeek)
-

- Sets the plays trailing week count for this Video. -

- -

- - Property name: playsTrailingWeek
- Type: Integer
- Read only?: yes
- Description: How many times the Video has been played within - the past seven days, exclusive of today. - +

+ Sets the plays trailing week count for this Video. +

+ +

+ + Property name: playsTrailingWeek
+ Type: Integer
+ Read only?: yes
+ Description: How many times the Video has been played within + the past seven days, exclusive of today. +

@@ -2644,12 +2644,12 @@

public JSONObject toJson() throws JSONException
-

- Converts the video into a JSON object suitable for use with the Media API -

- -

- Null values will not be included in the JSON sent to the server. +

+ Converts the video into a JSON object suitable for use with the Media API +

+ +

+ Null values will not be included in the JSON sent to the server.

@@ -2667,8 +2667,8 @@

public JSONObject toJson(java.util.EnumSet<VideoFieldEnum> includeNullFields) throws JSONException
-

- Converts the video into a JSON object suitable for use with the Media API +

+ Converts the video into a JSON object suitable for use with the Media API

@@ -2685,9 +2685,9 @@ 

 public org.w3c.dom.Element appendXml(org.w3c.dom.Element root)
-

- Uses the W3C libraries to generate an XML representation of - this object. +

+ Uses the W3C libraries to generate an XML representation of + this object.

diff --git a/release-build/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html b/release-build/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html index a96d3c6d..60c4ee83 100755 --- a/release-build/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html +++ b/release-build/javadoc/com/brightcove/commons/catalog/objects/enumerations/ItemStateEnum.html @@ -102,13 +102,13 @@

-

The state a video is in.

- -

This enumeration is defined primarily by the Media API documentation for - an ItemStateEnum object: - http://docs.brightcove.com/en/media/#ItemStateEnum. -

-

This may be modified however from the Media API documentation so that it +

The state a video is in.

+ +

This enumeration is defined primarily by the Media API documentation for + an ItemStateEnum object: + http://docs.brightcove.com/en/media/#ItemStateEnum. +

+

This may be modified however from the Media API documentation so that it can also support other interfaces (e.g. batch provisioning).

@@ -143,6 +143,12 @@

INACTIVE +
+            + + +PENDING +
            @@ -170,7 +176,7 @@

values()
-          Returns an array containing the constants of this enum type, in +          Returns an array containing the constants of this enum type, in the order they're declared. @@ -234,6 +240,15 @@

+

+PENDING

+
+public static final ItemStateEnum PENDING
+
+
+
+
+ @@ -249,17 +264,17 @@ 

 public static final ItemStateEnum[] values()
-
Returns an array containing the constants of this enum type, in -the order they're declared. This method may be used to iterate -over the constants as follows: -
-for(ItemStateEnum c : ItemStateEnum.values())
-        System.out.println(c);
+
Returns an array containing the constants of this enum type, in
+the order they're declared.  This method may be used to iterate
+over the constants as follows:
+
+for(ItemStateEnum c : ItemStateEnum.values())
+        System.out.println(c);
 

 

 

 
-
Returns:
an array containing the constants of this enum type, in
+
Returns:
an array containing the constants of this enum type, in
 the order they're declared
@@ -270,16 +285,16 @@ 

 public static ItemStateEnum valueOf(java.lang.String name)
-
Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws: -
java.lang.IllegalArgumentException - if this enum type has no constant +
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name