ComponentService
Session Bean implementation class ComponentWebService.
Endpoint Metadata
- Namespace: http://opencase.extend.com/webservices/component
- Endpoint Name: ComponentWebService
- Endpoint Address: http(s)://{VMS URL}/ContentManager/webservices/component-service
The following methods are available on this endpoint:
Adds a components to a specified bundle. The bundle folder name indicates which item the component will be added to within the bundle.
Input Parameters
name |
type |
description |
identifierType |
string |
The identifier type specifies type of parent and child identifiers. Must be one of UUID, EXTERNAL_ID, and ASSET_ID. |
bundleIdentifier |
string |
The unique identifier (UUID|external id|asset id) of the bundle to add the component to. This must reference a valid bundle. |
componentIdentifiers |
list |
The unique identifiers (UUID|external id|asset id) of the components to add to the bundle. This must reference a valid components. Duplicates will be ignored. Components that are already attached to specified bundle will not be processed. |
bundleFolderName |
string |
The folder name of the bundle item that the child components will be added to. This must reference a valid bundle item. |
Faults
name |
description |
ComponentParameterFault |
If any parameter is invalid or if the component cannot be added to the bundle.The passed parameters areconsidered invalid in all of the following cases- unexpected identifierType
- bundleFolderName is null or empty
- bundleIdentifier is null or empty
- componentIdentifiers is null or empty
|
ComponentWebserviceFault |
(no documentation provided) |
Adds a component to a specified bundle. The bundle item indicates which item the component will be added to within the bundle.
For components which do not override AbstractComponent#getSuggestedDefaultOrderNumber() component will be added as last child ofthe parent bundle item (specified by parentBundleItemPk).
For components which override AbstractComponent#getSuggestedDefaultOrderNumber() value returned by this method will be used asorder of created bundle item
Input Parameters
name |
type |
description |
componentPk |
integer |
The primary key of the component to add to the bundle. This must reference a valid component. |
parentBundlePk |
integer |
The primary key of the bundle to add the component to. This must reference a valid bundle. |
parentBundleItemPk |
integer |
The primary key of the bundle item that the component will be added to. This must reference a valid bundle item. |
Faults
name |
description |
ComponentParameterFault |
If any parameter is invalid or if the component cannot be added to the bundle.The passed parameters areconsidered invalid in all of the following cases- componentPk is null or zero
- parentBundlePk is null or zero
- parentBundleItemPk is null or zero
|
Adds a component to a specified bundle with the specified order. The bundle item indicates which item the component will be added towithin the bundle.
Input Parameters
name |
type |
description |
componentPk |
integer |
The primary key of the component to add to the bundle. This must reference a valid component. |
parentBundlePk |
integer |
The primary key of the bundle to add the component to. This must reference a valid bundle. |
parentBundleItemPk |
integer |
The primary key of the bundle item that the component will be added to. This must reference a valid bundle item. |
order |
integer |
The order of the component to add to the bundle. Must be a positive number or NULL. NULL order value is treated as unspecified order and ComponentWebServiceLocal#addComponentToBundle(Integer, Integer, Integer) will be used to add component. |
Faults
name |
description |
ComponentParameterFault |
If any parameter is invalid or if the component cannot be added to the bundle.The passed parameters areconsidered invalid in all of the following cases- componentPk is null or zero
- parentBundlePk is null or zero
- parentBundleItemPk is null or zero
- order is zero or negative
|
Updates multiple components based on a set of bulkEditOperations. Updates can replace values or set to null a list of fields that are bulkeditable. The list of editable fields along with their relevant data types can be retrieved using the getBulkEditableFields method.
Input Parameters
name |
type |
description |
componentTypePk |
integer |
The componentType primary key related to this bulk update request. |
componentPksToUpdate |
integer[] |
The componentPks of the components to update. All components must be of the same type which means they should match the componentTypePk that was passed in. |
bulkEditOperations |
BulkEditOperation[]
|
The bulk update operations to perform. Each item contains fields that are bulk editable for the given componentType. This value specifies the type of update requested and provides new data if applicable. |
Faults
name |
description |
ComponentParameterFault |
If the passed parameters are invalid. The passed parameters are considered invalid in all of the followingcases- componentTypePk is null
- array of componentPksToUpdate is null or empty
- the array of bulkEditOperations is null or empty
|
ComponentWebserviceFault |
If the bulk edit operation fails for any reason. |
Retrieve a boolean value based on the parameters given.
Input Parameters
name |
type |
description |
bundlePk |
integer |
The primary key of the bundle to be check. |
componentPk |
integer |
The primary key of the component to be check. |
onlyDirectAncestor |
boolean |
If "True" the method is successful only if the component is a direct child of the bundle, if "False" the method is successful if the component is a descendant of the bundle in any way |
Return Value
type |
description |
boolean |
A value of true value if matches the criteria, otherwise a value of false value will be returned. |
Faults
name |
description |
ComponentParameterFault |
If bundlePk or componentPk is null or zero |
ComponentWebserviceFault |
If an error occurs while checking the bundle child. |
Cancel all bind request associated with a given list of processInstanceIds. When the workflow is ended manually, the bind requestsassociated with that process instance need to be cancelled in order to stop further processing.
Input Parameters
name |
type |
description |
processInstanceIds |
list |
The list of processInstance ids |
Faults
name |
description |
ComponentParameterFault |
If the processInstanceIds list is null or empty. |
ComponentWebserviceFault |
If any error occurs when trying to cancel a bind request |
Creates AbstractComponent for each component from the passed XML. Allows child components association if they exist in the system.
Input Parameters
name |
type |
description |
xml |
string |
An XML string containing the data for the component to be created, mandatory. |
childComponentsUpdateRule |
ComponentUpdateRule
|
Optional ComponentUpdateRule to be used when processing this update for child elements. If empty - all xml elements will be created. |
associateOrphanedComponents |
boolean |
Notifies if service should associate orphaned components. |
Return Value
type |
description |
list<Component>
|
List of created components from the given XML string. |
Faults
name |
description |
ComponentParameterFault |
If the XML is null or empty, childComponentsUpdateRule is null or if the component cannot be created. |
This method has been deprecated. As of release 5.7.2, replaced by#createBundleWithRestrictionKey(Integer bundleTemplate, String name, String alternateCode, String restrictionKey)
Creates a new bundle using the specified bundle type as a template to create the bundle structure.
Input Parameters
name |
type |
description |
bundleTemplate |
integer |
The primary key of the bundle template (A.K.A. bundle type) used to create the bundle structure. This required field must be a valid bundle template. |
name |
string |
The name for the new bundle. Must not be null. |
alternateCode |
string |
The alternate code for the new bundle. If null is specified, no alternate code will be assigned to the new bundle. |
Return Value
type |
description |
Bundle
|
The newly created bundle. |
Faults
name |
description |
ComponentParameterFault |
If bundleTemplate is null or name is null or empty |
Creates a new bundle using the specified bundle type as a template and Restriction Key to create the bundle structure.
Input Parameters
name |
type |
description |
bundleTemplate |
integer |
The primary key of the bundle template (A.K.A. bundle type) used to create the bundle structure. This required field must be a valid bundle template. |
name |
string |
The name for the new bundle. Must not be null. |
alternateCode |
string |
The alternate code for the new bundle. If null is specified, no alternate code will be assigned to the new bundle. |
restrictionKey |
string |
The Restriction Key for the new bundle. |
Return Value
type |
description |
Bundle
|
The newly created bundle. |
Faults
name |
description |
ComponentParameterFault |
If bundleTemplate is null or name is null or empty |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#createCommonEntity(AbstractCommonEntity)
In 5.1 the preferred way to create Category this is via CommonEntityWebServiceLocal#createCategories(List) otherwisethe legacy category will be created instead of hierarchical.
Input Parameters
name |
type |
description |
commonEntityToCreate |
CommonEntity
|
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
This method has been deprecated. Deprecated as of 5.1, replaced byCommonEntityWebServiceLocal#createCommonEntityWithLocales(AbstractCommonEntity, Integer[])
In 5.1 the preferred way to create Category this is via CommonEntityWebServiceLocal#createCategories(List) otherwisethe legacy category will be created instead of hierarchical.
Input Parameters
name |
type |
description |
commonEntityToCreate |
CommonEntity
|
(no documentation provided) |
localePks |
integer[] |
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Creates a new component using the passed component data.
The following basic validation is performed on the incoming component data:
Component Primary Key - Must not be specified. Component name - Must bespecified. Component Discriminator - Specifies the component type, such as ASSET_VIDEO or METADATA_VIDEO. Mustbe valid for the type of component being created. Component UUID - Must not be specified. Component Creation Date - Must not be specified. Component Last Modified Date - Must not bespecified.
Input Parameters
name |
type |
description |
componentToCreate |
Component
|
The component to be created. |
Return Value
type |
description |
Component
|
The created component. |
Faults
name |
description |
ComponentParameterFault |
If the passed component does not pass validation. The passed component is considered invalid in all of thefollowing cases- the componentToCreate is null
- the UUID of the componentToCreate has a value
- the createDate of the componentToCreate has a value
- the lastModifiedDate of the componentToCreate has a value
|
ComponentWebserviceFault |
For any business-related errors. |
Creates a component object from the passed XML.
Input Parameters
name |
type |
description |
xml |
string |
An XML string containing the data for the component to be created. |
Return Value
type |
description |
list<Component>
|
A component object created from the given XML string. |
Faults
name |
description |
ComponentParameterFault |
If the XML is null or empty or if the component cannot be created. |
Creates or updates classification bundle from given input XML, depending on its uuid.
Input Parameters
name |
type |
description |
xml |
string |
containing the data for the classification bundle to be created |
Return Value
type |
description |
Component
|
created classification bundle |
Faults
name |
description |
ComponentParameterFault |
if the XML is null or empty or if the classification bundle can not be created/updated |
ComponentWebserviceFault |
(no documentation provided) |
Creates or updates classification bundle from given input XML, depending on its uuid. Adds restriction key value to all components.
Input Parameters
name |
type |
description |
xml |
string |
containing the data for the classification bundle to be created |
restrictionKey |
string |
The Restriction Key for the components. |
Return Value
type |
description |
Component
|
created classification bundle |
Faults
name |
description |
ComponentParameterFault |
if the XML is null or empty or if the classification bundle can not be created/updated |
ComponentWebserviceFault |
(no documentation provided) |
Deletes a bundle passed to this method.
The following basic validation is performed on incoming bundles to be deleted:
Bundle Primary Key - Must match an existing bundle's primary key.
Input Parameters
name |
type |
description |
bundleToDeletePk |
integer |
The primary key of the bundle to delete. |
Faults
name |
description |
ComponentParameterFault |
If the bundle primary key passed for deletion is invalid. The bundle primary key is considered invalid ifit is null |
ComponentWebserviceFault |
If the bundle is shared by other bundles or the bundle has a product associated to it or any otherbusiness related error occurs |
Delete a bundle and its components passed to this method.
The following basic validation is performed on the incoming bundle and components:
Bundle Primary Key - Must match an existing bundle's primary key. Component Primary Key - Must match an existing component's primary key.
Input Parameters
name |
type |
description |
bundleToDeletePk |
integer |
The primary key for the bundle to delete. |
componentsToDeletePks |
integer[] |
A list of primary keys for components to delete; list must not be null and must not be empty; pks must match existing components. |
Faults
name |
description |
ComponentParameterFault |
If any passed bundle primary key is null or component primary key array is null |
ComponentWebserviceFault |
If the bundle is shared by other bundles or the bundle has a product associated to it or any of thepassed component is shared by other bundles or any other business related error occurs |
Deletes a bundle passed to this method, and removes its association with all of its parent bundles.
The following basic validation is performed on incoming bundles to be deleted:
Bundle Primary Key - Must match an existing bundle's primary key.
Input Parameters
name |
type |
description |
bundleToDeletePk |
integer |
The primary key of the bundle to delete. |
Faults
name |
description |
ComponentParameterFault |
If the bundle primary key passed for deletion is invalid. The bundle primary key is considered invalid ifit is null |
ComponentWebserviceFault |
If the bundle has a product associated to it or any other business related error occurs |
Delete bundle and all it's components. If bundle is associated with parent then remove it from the parent first.
Input Parameters
name |
type |
description |
bundlePk |
integer |
the bundle Pk |
Faults
name |
description |
ComponentParameterFault |
Thrown when any of service parameter is null or empty. |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#deleteCommonEntity(AbstractCommonEntity)
In 5.1 the preferred way to delete Category this is viaCommonEntityWebServiceLocal#deleteCategory(com.extend.opencase.cm.model.commonentity.HierarchicalCategory) otherwisethe legacy category can be deleted.
Input Parameters
name |
type |
description |
commonEntityToDelete |
CommonEntity
|
(no documentation provided) |
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Deletes components passed to this method.
The following basic validation is performed on the incoming components:
Component Primary Key - Must match an existing component's primary key.
Input Parameters
name |
type |
description |
componentsToDeletePks |
integer[] |
The list of primary keys for components to delete. |
Faults
name |
description |
ComponentParameterFault |
If the component primary key array passed for deletion is null |
ComponentWebserviceFault |
If the any of the component is a part of an existing bundle or any other business related error occurs |
Retrieves all active bind profiles.
Return Value
type |
description |
list<BindProfile>
|
A list of active bind profiles. If no active bind profiles are found, an empty list is returned. |
Faults
name |
description |
ComponentWebserviceFault |
If an error occurs while generating the list of active bind profiles. |
Finds list of externalIDs from all available Bundles disregarding state (both active and inactive are encountered).
Return Value
type |
description |
list |
list with string representation of externalID for each existing bundle |
Faults
name |
description |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request |
Finds list of ProviderID and ProviderAssetID pairs from all available Bundles disregarding state (both active and inactive areencountered) in next format: ProviderId/ProviderAssetId. PID/PAID pair will be present in Result Set only if both of them are non-empty inDB.
Return Value
type |
description |
list |
list with string representation for ProviderID and and ProviderAssetID for all existing bundles |
Faults
name |
description |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#findAllCommonEntitiesByType(String)
Input Parameters
name |
type |
description |
discriminator |
string |
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Returns a list of all locales ordered alphabetically by language and country in the ascending order.
- language - lower case two-letter ISO-639 code.
- country - upper case two-letter ISO-3166 code.
Return Value
type |
description |
list<Locale>
|
a list of Locale objects or null if no locales exist. |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#findAllTalentRoles()
Return Value
Faults
name |
description |
ComponentWebserviceFault |
(no documentation provided) |
Finds a bind profile with a specific primary key. Since primary keys are unique, this method returns one bind profile.
Input Parameters
name |
type |
description |
bindProfilePk |
integer |
The primary key field for the bind profile to retrieve. |
Return Value
type |
description |
BindProfile
|
The bind profile matching the specified primary key specified. If no bind profile is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified bindProfilePk is null or zero |
ComponentWebserviceFault |
If some unexpected error occurred. |
Finds the bind profile with a specific UUID. Since the UUID field is unique, this method returns one bind profile.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID field for the bind profile to retrieve. |
Return Value
type |
description |
BindProfile
|
The bind profile matching the specified UUID. If no matching bind profile is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified UUID is null or empty |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Finds a bundle with a specific external ID. Since the external ID field is unique, this method will only return one bundle. Allsub-bundles are stripped from the found bundle and will not be returned.
Input Parameters
name |
type |
description |
externalId |
string |
The external ID field of the bundle to retrieve. |
Return Value
type |
description |
Component
|
A bundle matching the specified externalID. If no bundle is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the externalId parameter is null or empty. |
ComponentWebserviceFault |
If unexpected application exception occurs or if the found component is not an instance of aBundle. |
Gets the bundle associated with the identifier fields specified.
Input Parameters
name |
type |
description |
identifierName |
string |
The name of the identifier's type. This value can be obtained from schema definition, referring to the name attribute of the xs:complexType related to this Identifier. |
identifierField |
string |
A field to search in the identifier type. |
identifierValue |
string |
A value the identifierField will contain for a match. |
Return Value
type |
description |
Component
|
The bundle associated with the found identifier. |
Faults
name |
description |
ComponentParameterFault |
Thrown when any of service parameter is null or empty. |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
Finds a bundle with a specific PK. Since the external ID field is unique, this method will only return one bundle.
Input Parameters
name |
type |
description |
bundlePk |
integer |
The bundle pk |
Return Value
type |
description |
Component
|
A bundle matching the specified externalID. If no bundle is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the externalId parameter is null or empty. |
ComponentWebserviceFault |
If unexpected application exception occurs or if the found component is not an instance of aBundle. |
Finds a bundle with a specific PK. Since the external ID field is unique, this method will only return one bundle. All sub-bundles arestripped from the found bundle and will not be returned.
Input Parameters
name |
type |
description |
bundlePk |
integer |
The bundle pk |
Return Value
type |
description |
Component
|
A bundle matching the specified externalID. If no bundle is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the externalId parameter is null or empty. |
ComponentWebserviceFault |
If unexpected application exception occurs or if the found component is not an instance of aBundle. |
Finds a bundle with a specific PK, and all sub-bundles up to a maximum depth. All sub-bundles deeper than the maximum depth are strippedfrom the found bundle and will not be returned.
Input Parameters
name |
type |
description |
bundlePk |
integer |
The bundle pk |
depth |
integer |
The maximum depth of sub-bundles to be retrieved. This value must be greater than or equal to zero. |
Return Value
type |
description |
Component
|
A bundle matching the specified bundle PK. If no bundle is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the bundlePk parameter is null or empty. |
ComponentWebserviceFault |
If unexpected application exception occurs or if the found component is not an instance of aBundle. |
Finds bundles by subscription code internal use
Input Parameters
name |
type |
description |
subscriptionCodePks |
list |
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentWebserviceFault |
(no documentation provided) |
Finds bundle by subscription code and bundle type internal use
Input Parameters
name |
type |
description |
subscriptionCodePks |
list |
(no documentation provided) |
bundleTypePks |
list |
list of primary keys of bundle types |
Return Value
Faults
name |
description |
ComponentWebserviceFault |
(no documentation provided) |
Gets the bundle list with the identifier fields specified.
Input Parameters
name |
type |
description |
identifierName |
string |
The name of the identifier's type. This value can be obtained from schema definition, referring to the name attribute of the xs:complexType related to this Identifier. |
identifierField |
string |
A field to search in the identifier type. |
identifierValue |
string |
A value the identifierField will contain for a match. |
Return Value
type |
description |
list<Component>
|
The bundle associated with the found identifier. |
Faults
name |
description |
ComponentParameterFault |
Thrown when any of service parameter is null or empty. |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
Returns a list of bundles matching the bundle type primary key and last modified date parameters. The specified pagination informationwill be used to restrict the number of results.
Input Parameters
name |
type |
description |
bundleTypePk |
integer |
The primary key of the bundle type associate with the bundle to match. |
lastModified |
date |
A date filter in which the bundle must be modified after. |
pagingInfo |
PagingInfo
|
Parameters indicating how paging will be implemented. This options will allow for paging of results by pages of results or by ranges of results. |
Return Value
Faults
name |
description |
ComponentParameterFault |
If any of the search parameters specified are null or empty. |
ComponentWebserviceFault |
If any error occurs when trying to find bundles matching the search criteria. |
This method has been deprecated.
Finds paged and sorted by name collection of Bundles of a certain type specified by BundleType Pk. For all bundles just Pk and nameproperties are set.
Input Parameters
name |
type |
description |
bundlePks |
list |
the collection of bundle Pks |
bundleTypePk |
integer |
the pk of Bundle Type |
nameSearchTerm |
string |
the search term for bundle name |
pagingInfo |
PagingInfo
|
the paging info |
ascending |
boolean |
the ascending order |
Return Value
type |
description |
list<Bundle>
|
found collection of bundles or empty collection |
Faults
name |
description |
ComponentParameterFault |
if collection of bundlePks is null or empty |
ComponentWebserviceFault |
in case of any error during fetching bundle names. |
Finds the Name of a bundle type from the table OCM_TYPE
Input Parameters
name |
type |
description |
bundleTypePk |
integer |
(no documentation provided) |
Return Value
type |
description |
string |
Name of Bundle Type |
Faults
name |
description |
ComponentWebserviceFault |
(no documentation provided) |
Return Bundle type name by Bundle primary key.
Input Parameters
name |
type |
description |
bundlePk |
integer |
Bundle primary key |
Return Value
type |
description |
string |
Bundle type name |
Faults
name |
description |
ComponentParameterFault |
if bundlePk is null |
Finds a bundle UUID by ciid and classification type.
Input Parameters
name |
type |
description |
ciid |
string |
the corresponding id of bundle in ci |
bundleClassification |
BundleClassification
|
the classification type of the searched bundle |
Return Value
type |
description |
string |
bundle UUID of the bundle with matching ciid and classification |
Faults
name |
description |
ComponentParameterFault |
Thrown when any of service parameter is null or empty. |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
Finds Asset ID of the catalog bundle that has a CatalogAttribute component with the provided catalogId.
Input Parameters
name |
type |
description |
catalogId |
string |
the CatalogAttribute.catalogId |
Return Value
type |
description |
string |
catalog bundle asset ID |
Faults
name |
description |
ComponentParameterFault |
Thrown when any of service parameter is null or empty. |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#findCommonEntities(AbstractCommonEntity)
Input Parameters
name |
type |
description |
abstractCommonEntity |
CommonEntity
|
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#findCommonEntityByPrimaryKey(Integer)
Input Parameters
name |
type |
description |
commonEntityPrimaryKey |
integer |
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#findCommonEntityByUuid(String)
Input Parameters
name |
type |
description |
uuid |
string |
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Finds components with a specific alternate code.
Input Parameters
name |
type |
description |
altCode |
string |
The alternate code field of the components to retrieve. |
Return Value
type |
description |
list<Component>
|
A list of components matching the specified alternate code. If no components are found, an empty component list is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified parameter is invalid. The parameter altCode is considered invalid if it is null or empty |
ComponentWebserviceFault |
if unexpected application exception occurs. |
Finds component with a specific assetID.
Input Parameters
name |
type |
description |
assetID |
string |
The assetID field of the component to retrieve. |
Return Value
type |
description |
Component
|
Component matching the specified assetID. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the specified parameter is null or empty |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
Finds a component with a specific externalID. Since the externalID field is unique, this method returns one component.
Input Parameters
name |
type |
description |
externalID |
string |
The externalID field of the component to retrieve. |
Return Value
type |
description |
Component
|
A component matching the specified externalID. If no component is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the specified parameter is null or empty |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
Finds a component with a specific primary key. Since the primary key field is unique, this method returns one component.
Input Parameters
name |
type |
description |
componentPrimaryKey |
integer |
The primary key of the component to retrieve. |
Return Value
type |
description |
Component
|
A component matching the specified primary key. If no component is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified parameter is invalid. The parameter is considered invalid in all of the following cases- the componentPrimaryKey is null or zero
- no component exists with the given componentPrimaryKey
|
Finds a component with a specific UUID. Since the UUID field is unique, this method returns one component.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID field of the component to retrieve. |
Return Value
type |
description |
Component
|
A component matching the specified UUID. If no component is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified parameter is invalid. The parameter UUID is considered invalid if it is null or empty |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Find component collection with a specific sourceAssetID. Since sourceAssetID field is not unique, this method returns a component collection.
Input Parameters
name |
type |
description |
sourceAssetID |
string |
it contains the original component assetID |
Return Value
type |
description |
list<Component>
|
the component list that matches the sourceAssetID |
Faults
name |
description |
ComponentParameterFault |
if the sourceAssetID is null or empty |
ComponentWebserviceFault |
A business exception throw for any non-parameter errors. |
find Licensing Window object if exists in a direct parent bundle of a component in a product. If multiple License Window objects exist,this method returns the one with earliest Start Date. If no window exists, returns null.
Input Parameters
name |
type |
description |
uuid |
string |
- the component's UUID |
productPk |
integer |
- product's primary key |
Return Value
type |
description |
LicensingWindow
|
LicensingWindow matching the parameters specified. If no matching licensing window is found, a null value isreturned. |
Faults
name |
description |
ComponentParameterFault |
- is thrown if UUID or product's primary key is invalid |
ComponentWebserviceFault |
- is thrown if there's a general exception while retrieving Licensing Window |
Finds a locale with a specific primary key. Since the primary key field is unique, this method returns one locale.
Input Parameters
name |
type |
description |
localePrimaryKey |
integer |
The primary key of the locale to retrieve. |
Return Value
type |
description |
Locale
|
A locale matching the specified primary key. If no locale is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified parameter is invalid. The parameter is considered invalid if the localePrimary is null orzero |
Finds a locale matching a given language and country.
Input Parameters
name |
type |
description |
language |
string |
The language of the requested locale. Must not be null. |
country |
string |
The country of the requested locale. May be null. - language - lower case two-letter ISO-639 code.
- country - upper case two-letter ISO-3166 code.
|
Return Value
type |
description |
Locale
|
A locale value. If no locale is found, a null value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the specified parameter is invalid. The specified parameter is considered invalid if the language isnull or empty |
Retrieves origin mapping that maps to give baseURL
Input Parameters
name |
type |
description |
baseURL |
string |
to map origin mapping |
Return Value
Faults
name |
description |
ComponentWebserviceFault |
(no documentation provided) |
Retrieves all origin mapping.
Return Value
type |
description |
list<OriginMapping>
|
A list of origin mapping. If no mappings are found, an empty list is returned. |
Faults
name |
description |
ComponentWebserviceFault |
If an error occurs while generating the list of origin mapping. |
Finds the parent bundle item type names of a bundle item(for example, the folder names are the bundle item type name of componentsadded to these folders)
Input Parameters
name |
type |
description |
assetId |
string |
the component assetId or the component source assetId of a bundle item |
Return Value
type |
description |
list |
list of types(names) of the parent bundle item |
Faults
name |
description |
ComponentParameterFault |
Thrown when any of service parameter is null or empty. |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#findPersons(Person)
Input Parameters
name |
type |
description |
person |
Person
|
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Finds a PhysicalAsset with a specific contentID. Since the contentID field is not unique, if more than one PhysicalAsset found, exceptionis being thrown.
Input Parameters
name |
type |
description |
contentID |
string |
The contentID field for the PhysicalAsset to retrieve. |
Return Value
type |
description |
PhysicalAsset
|
The PhysicalAsset matching the specified contentID. If no PhysicalAsset with the matching contentID was found, a nullvalue is returned. |
Faults
name |
description |
ComponentParameterFault |
If the contentID is null or empty |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Finds PhysicalAssets contentFileUuids of witch is present in passed collection.
Input Parameters
name |
type |
description |
contentFileUuids |
list |
Collection of ContentFile UUIDs. |
Return Value
type |
description |
list<PhysicalAsset>
|
PhysicalAssets contentFileUuids of witch is present in passed collection |
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Finds physicalAsset collection with a specific contentID. Since the contentID field is not unique, this method returns a PhysicalAssetcollection.
Input Parameters
name |
type |
description |
contentID |
string |
The contentID field for the PhysicalAsset to retrieve. |
Return Value
type |
description |
list<PhysicalAsset>
|
The PhysicalAsset matching the specified contentID. If no PhysicalAsset with the matching contentID was found, a nullvalue is returned. |
Faults
name |
description |
ComponentParameterFault |
If the contentID is null or empty |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Finds physicalAsset collection with a specific MOS contentID. Since the MOS contentID field is not unique, this method returns aPhysicalAsset collection.
Input Parameters
name |
type |
description |
mosContentID |
string |
(no documentation provided) |
Return Value
type |
description |
list<PhysicalAsset>
|
The PhysicalAsset matching the specified MOS contentID. If no PhysicalAsset with the matching MOS contentID was found, anull value is returned. |
Faults
name |
description |
ComponentParameterFault |
If the contentID is null or empty |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Finds physicalAsset collection with a specific releaseUrl.
Input Parameters
name |
type |
description |
releaseUrl |
string |
releaseUrl for physicalAsset |
Return Value
Faults
name |
description |
ComponentParameterFault |
If the releaseUrl is null or empty |
ComponentWebserviceFault |
a business exception thrown for any non-parameter errors |
Find physical asset collection with a specific sourceAssetID. Since sourceAssetID field is not unique, this method returns a component collection.
Input Parameters
name |
type |
description |
sourceAssetID |
string |
it contains the original component assetID |
Return Value
Faults
name |
description |
ComponentParameterFault |
if the sourceAssetID is null or empty |
ComponentWebserviceFault |
A business exception throw for any non-parameter errors. |
Finds subscription policy
Return Value
Returns a list of bulk editable field info that can be used to generate valid input for the bulkEdit method.
Input Parameters
name |
type |
description |
componentTypePk |
integer |
The componentType related to this bulk update request. |
Return Value
type |
description |
list<BulkEditableField>
|
The list of BulkEditableFields relevant to this componentType. If there is no bulkEditableField for this component type and emptylist is returned |
Faults
name |
description |
ComponentParameterFault |
If the passed parameter is null or zero |
ComponentWebserviceFault |
If any error occurs while generating the list. |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Use #getBundleXMLByAssetID(String)instead of this one.
Get Bundle XML by providing an asset ID
Input Parameters
name |
type |
description |
assetId |
string |
the bundle component asset ID |
Return Value
type |
description |
string |
Bundle XML |
Faults
name |
description |
ComponentParameterFault |
Thrown if the input Id value is null or empty. |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Use#getBundleXMLByComponentPrimaryKey(Integer) instead of this one.
Get bundle XML by a component primary key.
Input Parameters
name |
type |
description |
componentPk |
integer |
component primary key |
Return Value
type |
description |
string |
Bundle XML |
Faults
name |
description |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Use #getBundleXMLByExternalID(String)instead of this one.
Get bundle XML by external Id
Input Parameters
name |
type |
description |
externalID |
string |
external id of the bundle to find. Must not be null. |
Return Value
type |
description |
string |
Bundle XML that was found by given external id. |
Faults
name |
description |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Use #getBundleXMLByProductUuid(String)instead of this one.
Gets the bundle XML for a bundle with a particular product UUID.
Input Parameters
name |
type |
description |
productUuid |
string |
The Product UUID to use to retrieve the bundle XML. |
Return Value
type |
description |
string |
Bundle XML. |
Faults
name |
description |
ComponentWebserviceFault |
If the product with the specified UUID cannot be found or if an error occurs trying to find the product. |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Use #getBundleXMLByUuid(String)instead of this one.
Gets the bundle XML for a bundle with a particular UUID.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID to use to retrieve the bundle XML. |
Return Value
type |
description |
string |
Bundle XML. |
Faults
name |
description |
ComponentWebserviceFault |
Exception thrown if the bundle does not exist, or an error occurred marshalling the bundle to XML. |
This method has been deprecated.
Finds the number of bundles of a certain type specified by BundleType Pk, which Pk's are in specified collection and name is likespecified search term.
Input Parameters
name |
type |
description |
bundlePks |
list |
the collection of bundle Pks to count |
bundleTypePk |
integer |
the pk of Bundle Type |
nameSearchTerm |
string |
the search term for bundle name |
Return Value
type |
description |
long |
the number of found bundles |
Faults
name |
description |
ComponentParameterFault |
if collection of bundlePks is null or empty |
ComponentWebserviceFault |
in case of any error during count bundles. |
Get Bundle XML by providing an asset ID
Input Parameters
name |
type |
description |
assetId |
string |
the bundle component asset ID |
Return Value
type |
description |
string |
Bundle XML |
Faults
name |
description |
ComponentParameterFault |
Input Id value is null or empty. |
ComponentWebserviceFault |
Failure to marshall bundle to XML. |
Get bundle XML by a component primary key.
Input Parameters
name |
type |
description |
componentPk |
integer |
component primary key |
Return Value
type |
description |
string |
Bundle XML |
Faults
name |
description |
ComponentWebserviceFault |
If an error occurs trying to marshall the bundle to XML. |
Get bundle XML by external Id
Input Parameters
name |
type |
description |
externalID |
string |
external id of the bundle to find. Must not be null. |
Return Value
type |
description |
string |
Bundle XML that was found by given external id. |
Faults
name |
description |
ComponentWebserviceFault |
Failure to marshall bundle to XML. |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Use#getBundleXMLByIdentifier(String, String) instead of this one.
Get Bundle XML by providing a ID type and a ID value. The ID type must be one of UUID, EXTERNAL_ID, and ASSET_ID.
Input Parameters
name |
type |
description |
idType |
string |
The ID type must be one of UUID, EXTERNAL_ID, and ASSET_ID. |
id |
string |
the ID value. |
Return Value
type |
description |
string |
Bundle XML. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the input Id value is null or empty. |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
Get Bundle XML by providing a ID type and a ID value. The ID type must be one of UUID, EXTERNAL_ID, or ASSET_ID.
Input Parameters
name |
type |
description |
idType |
string |
The ID type must be one of UUID, EXTERNAL_ID, or ASSET_ID. |
idValue |
string |
the ID value. |
Return Value
type |
description |
string |
Bundle XML. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the input Id value is null or empty. |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
Get Root Bundle XML by providing a ID type and a ID value. The ID type must be one of UUID, EXTERNAL_ID, or ASSET_ID.Only top-level bundle is returned, bundle items which are bundles themselves are excluded from result.
Input Parameters
name |
type |
description |
idType |
string |
The ID type must be one of UUID, EXTERNAL_ID, or ASSET_ID. |
idValue |
string |
the ID value. |
Return Value
type |
description |
string |
Bundle XML. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the input Id value is null or empty. |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
Find a bundle associated with the product specified by the product UUID and returns the bundle as XML.
Input Parameters
name |
type |
description |
productUuid |
string |
The product UUID associated with the bundle to return. |
Return Value
type |
description |
string |
The bundle associated with the product specified as XML. |
Faults
name |
description |
ComponentWebserviceFault |
If an error occurs trying to marshall the bundle to XML. |
Get bundle XML by a bundle's UUID.
Input Parameters
name |
type |
description |
uuid |
string |
of the bundle to search |
Return Value
type |
description |
string |
bundle XML with given UUID. |
Faults
name |
description |
ComponentWebserviceFault |
Failure to marshall the bundle to XML. |
Finds component's UUID based on passed identifier from com.extend.opencase.cm.util.ComponentIdType.
Input Parameters
name |
type |
description |
idType |
string |
type of identifier |
idValue |
string |
value of identifier |
Return Value
type |
description |
string |
string UUID of found component or null if component wasn't found |
Faults
name |
description |
ComponentParameterFault |
if identifier type (idType) is empty or not valid or value is empty |
ComponentWebserviceFault |
(no documentation provided) |
This method has been deprecated. Deprecated as of 5.7.0.1 because an error occurs if entity was not found in DB. Also, the parameter name 'id' does not matchthe corresponding parent method's parameter name of 'idValue'. Use #getComponentXMLByIdentifier(String, String)instead of this one.
Get Component source XML by providing a ID type and a ID value. The ID type must be one of UUID, EXTERNAL_ID, and ASSET_ID.
Input Parameters
name |
type |
description |
idType |
string |
The ID type must be one of UUID, EXTERNAL_ID, and ASSET_ID. |
id |
string |
the ID value. |
Return Value
type |
description |
string |
Component source value. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the input Id value is null or empty. |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
Get Component source XML by providing a ID type and a ID value. The ID type must be one of UUID, EXTERNAL_ID, and ASSET_ID.
Input Parameters
name |
type |
description |
idType |
string |
The ID type must be one of UUID, EXTERNAL_ID, and ASSET_ID. |
idValue |
string |
the ID value. |
Return Value
type |
description |
string |
Component source value. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the input Id value is null or empty. |
ComponentWebserviceFault |
Thrown if unexpected application exception occurs. |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#getDirectProviderForBundle(String, String)
Input Parameters
name |
type |
description |
componentUuid |
string |
(no documentation provided) |
bundleUuid |
string |
(no documentation provided) |
Return Value
type |
description |
Provider
|
(no documentation provided) |
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#getProviderForBundle(String)
Input Parameters
name |
type |
description |
bundleUuid |
string |
(no documentation provided) |
Return Value
type |
description |
Provider
|
(no documentation provided) |
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Creates or updates classification bundle from given input XML, depending on its uuid.
Input Parameters
name |
type |
description |
xml |
string |
containing the data for the classification bundle to be created |
restrictionKey |
string |
The Restriction Key for the components. |
updateNodeWithoutDisassociateChildren |
boolean |
Update node without disassociate children |
cleanupDisassociatedNode |
boolean |
Cleanup disassociated node |
Return Value
type |
description |
Component
|
created classification bundle |
Faults
name |
description |
ComponentParameterFault |
if the XML is null or empty or if the classification bundle can not be created/updated |
ComponentWebserviceFault |
(no documentation provided) |
Checks whether bundle exists that associated with the identifier fields specified.
Input Parameters
name |
type |
description |
identifierName |
string |
The name of the identifier's type. This value can be obtained from schema definition, referring to the name attribute of the xs:complexType related to this Identifier. |
identifierField |
string |
A field to search in the identifier type. |
identifierValue |
string |
A value the identifierField will contain for a match. |
Return Value
type |
description |
boolean |
[true] if one or more bundles exists (active/inactive), [false] if nothing found |
Faults
name |
description |
ComponentWebserviceFault |
Thrown when some internal error prevent from proceeding with request. |
Checks whether exists Bundle with specified Primary Key.
Input Parameters
name |
type |
description |
bundlePk |
integer |
the bundle pk to check |
Return Value
type |
description |
boolean |
true if bundle exists, false otherwise |
Faults
name |
description |
ComponentParameterFault |
in case input bundlePk is null. |
ComponentWebserviceFault |
if unexpected application exception occurs. |
Marshals a list of components object from the passed list of components. No components are persisted.
Note - Bundle objects are not allowed for this method.
Input Parameters
name |
type |
description |
components |
list<Component>
|
A list of components to be marshaled. |
Return Value
type |
description |
string |
A XML string with the marshaled components. No objects are persisted. |
Faults
name |
description |
ComponentParameterFault |
If the components is null or empty or if the list of components cannot be marshaled. |
Merges two component XML documents together to create a combined document. The fields from the secondary XML document will replace thefields in the primary XML document.
Input Parameters
name |
type |
description |
primaryXml |
string |
The primary component XML document that will be used as the master document. |
secondaryXml |
string |
The secondary component XML document that will be used to replace fields in the primary component XML document. |
replaceAbsentValues |
boolean |
If set to true, values not specified in the secondary XML will be removed from the primary XML. A value of false will remove the values from the primary XML. |
Return Value
type |
description |
string |
The merged XML document containing the fields from the primary component document and the replaced values from the secondarycomponent document. |
Faults
name |
description |
ComponentWebserviceFault |
If the merging of the two component XML documents fails. A failure could be caused by one of the XMLdocuments failing to unmarshall into a component object or if the merging of the documents fails. |
Retrieve a integer value based on the parameters given.
Input Parameters
name |
type |
description |
componentPk |
integer |
The primary key of the component to be check. |
Return Value
type |
description |
integer |
Number of bundle items the component is associated with |
Faults
name |
description |
ComponentParameterFault |
If componentPk is null or zero |
ComponentWebserviceFault |
If an error occurs while checking the bundles. |
Removes a bundleItem and its children for the bundleItemPk provided. If the bundleItemPk belongs to a bundle folder, an exception will bethrown
Input Parameters
name |
type |
description |
bundleItemPk |
integer |
The primary key of the bundleItem to be removed |
Faults
name |
description |
ComponentParameterFault |
Thrown if the bundleItemPk passed in is null or zero |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Removes a component from a given bundle
Input Parameters
name |
type |
description |
bundlePk |
integer |
The primary key of the bundle from which the component is to be removed |
componentPk |
integer |
The primary key of the component to be removed from bundle |
Faults
name |
description |
ComponentParameterFault |
Thrown if the bundlePk or componentPk passed in is null or zero |
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
Update Physical Assets by cDVRInUse parameter.
Input Parameters
name |
type |
description |
releaseURL |
string |
A Release URL that maps to zero or more PhysicalAssets. |
cDVRInUse |
boolean |
A Boolean indicates what to set the cDVRInUse flag to for any PhysicalAssets matching the incoming releaseURL. |
Sets the Reverse EPG expiry date for all physical assets with the given content id.
Input Parameters
name |
type |
description |
locatorId |
string |
Identifier of physical assets of a specific program recorded on a specific source. Note: contentId = locatorId. |
expiryTime |
date |
Reverse EPG expiry date and time to set for all physical assets that share the same content id. |
Faults
name |
description |
ComponentParameterFault |
If any of the parameters specified are null |
ComponentWebserviceFault |
If any error occurs when trying to set expiry time to physical assets |
Transform bundle XML using XSLT with given template ID. XSLT transformation may take advantage of optional XSLT parameter map.
Input Parameters
name |
type |
description |
bundleXml |
string |
bundle XML to be transformed |
xsltTemplateId |
string |
Unique template ID for XSLT used to perform transformation |
xsltParameterStringMap |
StringMap
|
(no documentation provided) |
Return Value
type |
description |
string |
Bundle XML transformed using XSLT with given template ID. |
Faults
name |
description |
ComponentParameterFault |
if required parameters, bundleXml and xsltTemplateId, are null. |
ComponentWebserviceFault |
if transformation of bundleXml fails. |
Unmarshals a component object from the passed XML. No components are persisted.
Input Parameters
name |
type |
description |
xml |
string |
An XML string containing the data for the component to be unmarshaled. |
Return Value
type |
description |
list<Component>
|
A component object from the given XML string. No objects are persisted. |
Faults
name |
description |
ComponentParameterFault |
If the XML is null or empty or if the component cannot be unmarshaled. |
Updates the bundle passed to this method. This method will not modify any bundleItems within the bundle being updated.
The following incoming parameters must match the values of the existing bundle:
Bundle Primary Key Bundle Discriminator Bundle UUID Bundle Creation Date Bundle Last Modified Date
Input Parameters
name |
type |
description |
bundleToUpdate |
Bundle
|
The bundle that will be updated. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming component data does not pass validation. Passed parameters are considered invalidin any of the following cases:- bundleToUpdate is null
- the primary key of the bundleToUpdate is null or zero
- the UUID, descriminator, createDate, or lastModifiedDate of the passed bundle do not match the bundle in the database
|
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
This method has been deprecated. in favor of ComponentWebServiceLocal#updateBundleFromXMLByUuid
This method updates the bundle referenced by the bundlePk parameter.
Input Parameters
name |
type |
description |
xml |
string |
The XML to use in the update operation. |
bundlePkToUpdate |
integer |
The integer primary key of the bundle to update. |
componentUpdateRule |
ComponentUpdateRule
|
The ComponentUpdateRule to be used when processing this update. - ALT_CODE
- EXTERNAL_ID
- NAME
|
Return Value
type |
description |
Component
|
Returns the updated Component. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming parameters data does not pass validation. Passed parameters are considered invalidin any of the following cases:- XML is null
- XML contains more than one component
- XML doesn't match the ComponentType of the component to update
- componentPk is null or zero
- componentUpdateRule is null
|
ComponentWebserviceFault |
(no documentation provided) |
This method updates the bundle referenced by the UUID parameter.
Input Parameters
name |
type |
description |
xml |
string |
The XML to use in the update operation. |
bundleUuidToUpdate |
string |
The UUID of the bundle to update. |
childComponentsUpdateRule |
ComponentUpdateRule
|
The ComponentUpdateRule to be used when processing this update for child elements. - ALT_CODE
- EXTERNAL_ID
- NAME
|
associateOrphanedComponents |
boolean |
Notifies if service should associate orphaned components. |
Return Value
type |
description |
Component
|
Returns the updated Component. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming parameters data does not pass validation. Passed parameters are considered invalidin any of the following cases:- XML is null
- XML contains more than one component
- XML doesn't match the ComponentType of the component to update
- UUID is null or empty
- componentUpdateRule is null
|
ComponentWebserviceFault |
(no documentation provided) |
Update bundle item order number.
Input Parameters
name |
type |
description |
bundleItemsToUpdate |
list<BundleItem>
|
the list of bundle items to update |
Faults
name |
description |
ComponentParameterFault |
the component parameter fault |
ComponentWebserviceFault |
the component webservice fault |
This method decides how to update incoming component referenced by the UUID parameter. Incoming component is considered as bundle (withfolders and possible child components) if AbstractType obtained from component's xml top level component typeattribute has discriminator value of BundleType#ENTITY_ALIAS. Otherwise incoming component is regarded as simple component (nochild elements will be updated).
Input Parameters
name |
type |
description |
xml |
string |
The XML to use in the update operation. |
componentUuidToUpdate |
string |
The UUID of the component to update. |
childComponentsUpdateRule |
ComponentUpdateRule
|
The ComponentUpdateRule to be used when processing this update for child elements. - ALT_CODE
- EXTERNAL_ID
- NAME
|
associateOrphanedComponents |
boolean |
Notifies if service should associate orphaned components. |
Return Value
type |
description |
Component
|
Returns the updated Component. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming parameters data does not pass validation. Passed parameters are considered invalidin any of the following cases:- componentTypeName from incoming XML is empty
- any types couldn't be found for passed componentTypeName
- The specified component UUID is null or empty
- XML is null
- XML contains more than one root component (that would be main bundle)
- XML doesn't match the ComponentType of the component to update
For bundle component:
- componentUpdateRule is null
For simple component:
- XML contains a bundle
|
ComponentWebserviceFault |
if #updateBundleFromXMLByUuid or #updateComponentFromXMLByUuid throw exceptions duringupdate |
Performs same action as #updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) but returns componentidentifier instead of AbstractComponent. Component identifier is returned according to requested componentIdType.
Input Parameters
name |
type |
description |
xml |
string |
See xml in #updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) |
componentUuidToUpdate |
string |
See componentUuidToUpdate in #updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) |
childComponentsUpdateRule |
ComponentUpdateRule
|
See childComponentsUpdateRule in #updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) |
associateOrphanedComponents |
boolean |
See associateOrphanedComponents in #updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) |
componentIdType |
componentIdType
|
Type of the identifier to return. Required. |
Return Value
type |
description |
string |
One of the identifiers of the updated component |
Faults
name |
description |
ComponentParameterFault |
in case of null componentIdType and see ComponentParameterFault in#updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) |
ComponentWebserviceFault |
See ComponentWebserviceFault in#updateBundleOrComponentFromXMLByUuid(String, String, ComponentUpdateRule, Boolean) |
Updates the bundle passed to this method. This method will not modify any bundleItems within the bundle being updated. PassesIsBypassNotification transient field to the ComponentManager.
The following incoming parameters must match the values of the existing bundle:
Bundle Primary Key Bundle Discriminator Bundle UUID Bundle Creation Date Bundle Last Modified Date
Input Parameters
name |
type |
description |
bundleToUpdate |
Bundle
|
The bundle that will be updated. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming component data does not pass validation. Passed parameters are considered invalidin any of the following cases:- bundleToUpdate is null
- the primary key of the bundleToUpdate is null or zero
- the UUID, descriminator, createDate, or lastModifiedDate of the passed bundle do not match the bundle in the database
|
ComponentWebserviceFault |
A business exception thrown for any non-parameter errors |
This method has been deprecated. Deprecated as of 5.1, replaced by CommonEntityWebServiceLocal#updateCommonEntity(AbstractCommonEntity)
In 5.1 the preferred way to update Category this is viaCommonEntityWebServiceLocal#updateCategory(com.extend.opencase.cm.model.commonentity.HierarchicalCategory) otherwisethe legacy category can be updated.
Input Parameters
name |
type |
description |
commonEntityToUpdate |
CommonEntity
|
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
This method has been deprecated. Deprecated as of 5.1, replaced byCommonEntityWebServiceLocal#updateCommonEntityWithLocales(AbstractCommonEntity, Integer[])
In 5.1 the preferred way to update Category this is viaCommonEntityWebServiceLocal#updateCategory(com.extend.opencase.cm.model.commonentity.HierarchicalCategory) otherwisethe legacy category can be updated.
Input Parameters
name |
type |
description |
commonEntityToUpdate |
CommonEntity
|
(no documentation provided) |
localePks |
integer[] |
(no documentation provided) |
Return Value
Faults
name |
description |
ComponentParameterFault |
(no documentation provided) |
ComponentWebserviceFault |
(no documentation provided) |
Updates a component passed to this method. Note that bundles cannot be updated through this method. If the component passed in is a bundlethis method will throw an exception
The following incoming parameters must match the values of the existing component:
Component Primary Key Component Discriminator Component UUID Component Creation DateComponent Last Modified Date
Input Parameters
name |
type |
description |
componentToUpdate |
Component
|
The component that will be updated. |
Faults
name |
description |
ComponentParameterFault |
If the incoming component data does not pass validation.The passed parameter is considered invalid in allof the following cases- componentToUpdate is null
- the primary key of the componentToUpdate is null or zero
- the createDate,lastModifiedDate, UUID or discriminator of the componentToUpdate doesn't match with the existing component *
|
ComponentWebserviceFault |
If the componentToUpdate does not exist or componentToUpdate is a bundle or any business-related erroroccurs. |
This method has been deprecated. in favor of ComponentWebServiceLocal#updateComponentFromXMLByUuid
This method updates the component referenced by the componentPk parameter. This method updates only components,#updateBundleFromXML should be used to update bundles.
Input Parameters
name |
type |
description |
xml |
string |
The XML to use in the update operation. |
componentPk |
integer |
The integer primary key of the component to update. |
Return Value
type |
description |
Component
|
Returns the updated Component. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming parameters data does not pass validation. Passed parameters are considered invalidin any of the following cases:- XML is null
- XML contains more than one component
- XML doesn't match the ComponentType of the component to update
- XML contains a bundle
- The specified component primary key is null or zero
|
ComponentWebserviceFault |
(no documentation provided) |
This method updates the component referenced by the UUID parameter. This method updates only components,#updateBundleFromXMLByUuid should be used to update bundles.
Input Parameters
name |
type |
description |
xml |
string |
The XML to use in the update operation. |
componentUuid |
string |
The UUID of the component to update. |
Return Value
type |
description |
Component
|
Returns the updated Component. |
Faults
name |
description |
ComponentParameterFault |
Thrown if the incoming parameters data does not pass validation. Passed parameters are considered invalidin any of the following cases:- XML is null
- XML contains more than one component
- XML doesn't match the type of the component to update
- XML contains a bundle
- The specified component UUID is null or empty
|
ComponentWebserviceFault |
(no documentation provided) |