Package com.mayam.wf.ws.client

Class SegmentApi

java.lang.Object
com.mayam.wf.ws.client.SegmentApi
public class SegmentApi extends Object
API for dealing with segments This class is accessed using TasksClient.segmentApi() A segmentListId is the id of the segmentList as stored in the mam. It can be found inside the SegmentList 
        String segmentListId = list.getId();
A SegmentListList is a basically a ArrayList A revision is a specified revision of an asset. This is in the mam called Media Object Group (mog). a revisionId is what in the mam can be called a mog id. The AssetApi contains methods to deal with revisions
Author:
Erik Bågfors invalid input: '<'erik@mayam.com>

  • Constructor Details

    • SegmentApi

      public SegmentApi(com.mayam.wf.ws.client.internal.SegmentsRestClient sClient, com.mayam.wf.ws.client.internal.AssetSegmentsRestClient asClient)

  • Method Details

    • getSegmentListsForAsset

      public SegmentListList getSegmentListsForAsset(AssetType assetType, String assetId) throws RemoteException
      Returns all segment lists for asset.
      Parameters:
      assetType - asset type. Can be AssetType.ITEM or AssetType.REVISION.
      assetId - asset identifier (revision or item id).
      Returns:
      the list of segment lists.
      Throws:
      RemoteException - if an error occurred on the server side.

    • getSegmentList

      public SegmentList getSegmentList(String segmentListId) throws RemoteException
      Returns a segment list by its identifier.
      Parameters:
      segmentListId - segment list identifier.
      Returns:
      the segment list.
      Throws:
      RemoteException - if an error occurred on the server side.

    • getSegmentListBySiteId

      public SegmentList getSegmentListBySiteId(String siteId) throws RemoteException
      Returns a segment list by its site identifier.
      Parameters:
      siteId - site identifier.
      Returns:
      segment list.
      Throws:
      RemoteException - if an error occurred on the server side.

    • createSegmentList

      public SegmentList createSegmentList(AssetType assetType, String assetId, SegmentList segmentList) throws RemoteException
      Creates a new segment list.
      Parameters:
      assetType - asset type. Currently must be AssetType.REVISION.
      assetId - asset identifier.
      segmentList - segment list data.
      Returns:
      newly created segment list.
      Throws:
      RemoteException - if an error occurred on the server side.

    • deleteSegmentList

      public void deleteSegmentList(String segmentListId) throws RemoteException
      Deletes a segment list by its identifier.
      Parameters:
      segmentListId - segment list identifier.
      Throws:
      RemoteException - if an error occurred on the server side.

    • updateSegmentList

      public SegmentList updateSegmentList(String segmentListId, SegmentList segmentList) throws RemoteException
      Updates a given segment list.
      Parameters:
      segmentListId - segment list identifier.
      segmentList - segment list updates.
      Returns:
      updated segment list.
      Throws:
      RemoteException - if an error occurred on the server side.