|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.repository.RepositoryServices
public class RepositoryServices
A collection of web service methods pertaining to repositories
Field Summary | |
---|---|
static java.lang.String |
ADD_ITEM_METHOD
Constants for the names of methods that can be used as web services, used by the Web Services HTML Wizard for making repository services |
static java.lang.String |
ADD_TO_COLLECTION_PROPERTY_METHOD
|
static java.lang.String |
ADD_TO_MAP_PROPERTY_METHOD
|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
GET_ITEM_METHOD
|
static java.lang.String |
GET_MAP_PROPERTY_METHOD
|
static java.lang.String |
GET_PROPERTY_METHOD
|
static int |
NO_POSITION
|
static java.lang.String |
REMOVE_FROM_COLLECTION_PROPERTY_METHOD
|
static java.lang.String |
REMOVE_FROM_MAP_PROPERTY_METHOD
|
static java.lang.String |
REMOVE_ITEM_METHOD
|
static java.lang.String |
SET_PROPERTY_METHOD
|
static java.lang.String |
UPDATE_ITEM_METHOD
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.repository.RepositoryServiceConstants |
---|
ADD_ITEM_NULL, INVALID_ARRAY_ADD_INDEX, INVALID_ARRAY_INDEX, INVALID_ARRAY_REMOVE, INVALID_ARRAY_REMOVE_INDEX, INVALID_CLASS, INVALID_LIST_ADD_INDEX, INVALID_LIST_REMOVE, INVALID_LIST_REMOVE_INDEX, INVALID_SET_REMOVE, NULL_DESC, NULL_DESC_NAME, NULL_ID, NULL_ITEM, NULL_MAP_KEY, NULL_MAP_VALUE, NULL_PROP_DESC, NULL_REP, NULL_REP_PATH, NULL_RQL, RESOURCE_BUNDLE_NAME, sResourceBundle, UPDATE_ITEM_NULL |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
RepositoryServices()
|
Method Summary | |
---|---|
void |
addArrayPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToAdd)
Adds a value to an array property |
void |
addArrayPropertyValueAtIndex(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToAdd,
int pIndex)
Adds a value to an array property at the specified index |
void |
addCollectionPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToAdd)
Adds a value to a collection property i.e. |
void |
addListPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToAdd)
Adds a value to a List property. |
void |
addListPropertyValueAtIndex(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToAdd,
int pIndex)
Adds a value to a List property at the specified index |
void |
addMapPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.String pMapKey,
java.lang.Object pPropertyValue)
Adds a value to a Map property |
java.lang.String |
addRepositoryItem(java.lang.String pItemAsXML)
Adds an item to the repository |
java.lang.String |
addRepositoryItem(java.lang.String pItemAsXML,
java.lang.String pMappingFile)
Adds an item to the repository |
void |
addSetPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToAdd)
Adds a value to a Set property |
protected void |
commitTransaction()
Commits the current transaction |
protected javax.transaction.Transaction |
ensureTransaction()
This method ensures that a transaction exists before returning. |
atg.repository.xml.ItemDescriptorMappingManager |
getMappingManager()
Get property MappingManager |
java.lang.Object |
getMapPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.String pKey)
Gets a map property value from a repository item specified by the required arguments |
java.lang.String[] |
getPropertyNamesForItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName)
Returns an array of String containing the property names for a given repository item. |
java.lang.Object |
getPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName)
Gets a property value from a repository item specified by the required arguments |
java.lang.String |
getRepositoryItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId)
Gets a repository item in XML format with the given id and item descriptor from the given repository |
java.lang.String |
getRepositoryItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pMappingFile)
Gets a repository item in XML format with the given id and item descriptor from the given repository |
javax.transaction.TransactionManager |
getTransactionManager()
Get property TransactionManager |
AddService |
getXmlAddService()
Get property XmlAddService |
GetService |
getXmlGetService()
Get property XmlGetService |
UpdateService |
getXmlUpdateService()
Get property XmlUpdateService |
boolean |
isUseDefaultMappings()
Get property UseDefaultMappings |
int |
performRQLCountQuery(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRQLQuery)
Performs an RQL query using the given query statement against the given repository and item descriptor |
java.lang.String[] |
performRQLQuery(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRQLQuery)
Performs an RQL query using the given query statement against the given repository and item descriptor |
java.lang.String[] |
performRQLQuery(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRQLQuery,
java.lang.String pMappingFile)
Performs an RQL query using the given query statement against the given repository and item descriptor |
void |
removeArrayPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToRemove)
Removes a value from an array property |
void |
removeArrayPropertyValueAtIndex(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
int pIndex)
Removes a value from an array property |
void |
removeCollectionPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToRemove)
Removes a value from a collection property i.e. |
void |
removeListPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToRemove)
Removes a value from a List property |
void |
removeListPropertyValueAtIndex(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
int pIndex)
Removes a value from a List property |
java.lang.Object |
removeMapPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.String pMapKey)
Removes a value from a Map property |
void |
removeRepositoryItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId)
Removes an item from a repository. |
void |
removeSetPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pValueToRemove)
Removes a value from a Set property |
void |
setMappingManager(atg.repository.xml.ItemDescriptorMappingManager pMappingManager)
Set property MappingManager |
void |
setPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRepositoryId,
java.lang.String pPropertyName,
java.lang.Object pPropertyValue)
Sets pPropertyName to pPropertyValue on
the item specified by pRepositoryId found in the given
repository |
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Set property TransactionManager |
void |
setUseDefaultMappings(boolean pUseDefaultMappings)
Set property UseDefaultMappings |
void |
setXmlAddService(AddService pXmlAddService)
Set property XmlAddService |
void |
setXmlGetService(GetService pXmlGetService)
Set property XmlGetService |
void |
setXmlUpdateService(UpdateService pXmlUpdateService)
Set property XmlUpdateService |
java.lang.Object |
translatePropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pPropertyName,
java.lang.String pRepositoryId,
java.lang.Object pPassedInValue)
Translates the given property value depending on the class of the given property. |
void |
updateRepositoryItem(java.lang.String pItemAsXML)
Updates a repository item |
void |
updateRepositoryItem(java.lang.String pItemAsXML,
java.lang.String[] pMatchedProperties)
Updates a repository item |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String ADD_ITEM_METHOD
public static final java.lang.String GET_ITEM_METHOD
public static final java.lang.String REMOVE_ITEM_METHOD
public static final java.lang.String UPDATE_ITEM_METHOD
public static final java.lang.String SET_PROPERTY_METHOD
public static final java.lang.String GET_PROPERTY_METHOD
public static final java.lang.String ADD_TO_COLLECTION_PROPERTY_METHOD
public static final java.lang.String REMOVE_FROM_COLLECTION_PROPERTY_METHOD
public static final java.lang.String ADD_TO_MAP_PROPERTY_METHOD
public static final java.lang.String REMOVE_FROM_MAP_PROPERTY_METHOD
public static final java.lang.String GET_MAP_PROPERTY_METHOD
public static final int NO_POSITION
Constructor Detail |
---|
public RepositoryServices()
Method Detail |
---|
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
TransactionManager
pTransactionManager
- the transaction manager for all web servicespublic javax.transaction.TransactionManager getTransactionManager()
TransactionManager
public void setXmlGetService(GetService pXmlGetService)
XmlGetService
pXmlGetService
- the service that turns a RepositoryItem
into an XML filepublic GetService getXmlGetService()
XmlGetService
public void setXmlAddService(AddService pXmlAddService)
XmlAddService
pXmlAddService
- the service that adds a RepositoryItem in XML
format to a Repositorypublic AddService getXmlAddService()
XmlAddService
public void setXmlUpdateService(UpdateService pXmlUpdateService)
XmlUpdateService
pXmlUpdateService
- the service that updates a RepositoryItem in
XML formatpublic UpdateService getXmlUpdateService()
XmlUpdateService
public void setMappingManager(atg.repository.xml.ItemDescriptorMappingManager pMappingManager)
MappingManager
pMappingManager
- the service that controls mapping files for all
item descriptorspublic atg.repository.xml.ItemDescriptorMappingManager getMappingManager()
MappingManager
public void setUseDefaultMappings(boolean pUseDefaultMappings)
UseDefaultMappings
pUseDefaultMappings
- true if services that return Repo2Xml
items should use default mapping files supplied by the
ItemMappingManager
configured for this component. This
property is ignored if a mapping file is explicitly passed to
the servicepublic boolean isUseDefaultMappings()
UseDefaultMappings
ItemMappingManager
configured for this component. This
property is ignored if a mapping file is explicitly passed to
the servicepublic java.lang.String getRepositoryItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that holds
the requested itempItemDescriptorName
- the name of the item type to retrievepRepositoryId
- the id of the item to retrieve
RepositoryException
- if a repository error occurspublic java.lang.String getRepositoryItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pMappingFile) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that holds
the requested itempItemDescriptorName
- the name of the item type to retrievepRepositoryId
- the id of the item to retrievepMappingFile
- a file that can cull property values from
the returned XML file, so that not everything is transmitted back
to the client e.g. for a "user", you might want to not return
the value of the "password" property
RepositoryException
- if a repository error occurspublic java.lang.String addRepositoryItem(java.lang.String pItemAsXML) throws RepositoryException
pItemAsXML
- the item to add in XML format. The name of the
repository and the item's type are present in the XML format, so
those do not need to be supplied as arguments
RepositoryException
- if an error occurs adding the itempublic java.lang.String addRepositoryItem(java.lang.String pItemAsXML, java.lang.String pMappingFile) throws RepositoryException
pItemAsXML
- the item to add in XML format. The name of the
repository and the item's type are present in the XML format, so
those do not need to be supplied as argumentspMappingFile
- a file that can cull property values from
the returned XML file, so that not everything is transmitted back
to the client e.g. for a "user", you might want to not return
the value of the "password" property
RepositoryException
- if an error occurs adding the itempublic void updateRepositoryItem(java.lang.String pItemAsXML) throws RepositoryException
pItemAsXML
- the item to update in XML format. The name of the
repository and the item's type are present in the XML format, so
those do not need to be supplied as arguments. This method will determine
which known RepositoryItem to update based on the id specified in the
pItemAsXML
. If there is no existing item which matches that
id, then the item will be added to the repository
if the xmlUpdateService
component has its addWhenNoMatchedItems
flag set to true.
RepositoryException
- if an error occurs updating the item
in the repositorypublic void updateRepositoryItem(java.lang.String pItemAsXML, java.lang.String[] pMatchedProperties) throws RepositoryException
pItemAsXML
- the item to update in XML format. The name of the
repository and the item's type are present in the XML format, so
those do not need to be supplied as arguments. This method will determine
which known RepositoryItem to update based on the values of the
properties listed in pMatchedProperties
present in the
pItemAsXML
, or if that argument is null, the repositoryId
will be used to match items. If there is no existing item which matches
those property values, then the item will be added to the repository
if the xmlUpdateService
component has its addWhenNoMatchedItems
flag set to true.pMatchedProperties
- an array of property names that will be used
to match up values between the given pItemAsXML
and an
existing RepositoryItem object (note: use "repositoryId" to specify
the matching of ids)
RepositoryException
- if an error occurs updating the item
in the repositorypublic void removeRepositoryItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to removepItemDescriptorName
- the item type of the item to removepRepositoryId
- the id of the item to remove
RepositoryException
- if an error occurs removing the itempublic int performRQLCountQuery(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRQLQuery) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository to perform
the query againstpItemDescriptorName
- the item type of the returned itemspRQLQuery
- the query string to execute. This rql query must
not contain parameters i.e. all values must be filled
RepositoryException
- if a repository error occurspublic java.lang.String[] performRQLQuery(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRQLQuery) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository to perform
the query againstpItemDescriptorName
- the item type of the returned itemspRQLQuery
- the query string to execute. This RQL query must not
contain parameters i.e. all values must be filled
RepositoryException
- if a repository error occurspublic java.lang.String[] performRQLQuery(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRQLQuery, java.lang.String pMappingFile) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository to perform
the query againstpItemDescriptorName
- the item type of the returned itemspRQLQuery
- the query string to execute. This RQL query must not
contain parameters i.e. all values must be filledpMappingFile
- a file that can cull property values from
the returned XML file, so that not everything is transmitted back
to the client e.g. for a "user", you might want to not return
the value of the "password" property
RepositoryException
- if a repository error occurspublic void addCollectionPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToAdd) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the collection property to add a
value topValueToAdd
- the value to add to the collection
RepositoryException
- if any of the arguments are invalid,
or an error occurs adding the item to the collectionpublic void removeCollectionPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToRemove) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the collection property to remove a
property value frompValueToRemove
- the value to remove from the collection. For
List and array properties, this will be the first occurrance of
the item in the List or array.
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the collectionpublic void addListPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToAdd) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the List property to add a
value topValueToAdd
- the value to add to the end of the list
RepositoryException
- if any of the arguments are invalid, the
given property does not evaluate to a list, or an error occurs adding
the item to the collectionpublic void addListPropertyValueAtIndex(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToAdd, int pIndex) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the List property to add a
value topValueToAdd
- the value to add to the listpIndex
- the index to add the value at
RepositoryException
- if any of the arguments are invalid, the
given property does not evaluate to a list, or an error occurs adding
the item to the collectionpublic void removeListPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToRemove) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the List property to remove a
property value frompValueToRemove
- the value to remove from the collection. This will
be the first occurrance of the item in the List
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the Listpublic void removeListPropertyValueAtIndex(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, int pIndex) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the List property to remove a
property value frompIndex
- the index of the element to remove
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the Listpublic void addSetPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToAdd) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the Set property to add a
value topValueToAdd
- the value to add to the set
RepositoryException
- if any of the arguments are invalid, the
given property does not evaluate to a set, or an error occurs adding
the item to the collectionpublic void removeSetPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToRemove) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the Set property to remove a
property value frompValueToRemove
- the value to remove from the set.
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the Setpublic void addMapPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.String pMapKey, java.lang.Object pPropertyValue) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the map property to add a
value topMapKey
- the key of the entry to addpPropertyValue
- the value of the entry to add
RepositoryException
- if any of the arguments are invalid, the
given property does not evaluate to a map, or an error occurs adding
the item to the collectionpublic java.lang.Object removeMapPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.String pMapKey) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the Map property to remove a
property entry frompMapKey
- the key of the entry to remove
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the Setpublic void addArrayPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToAdd) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the array property to add a
value topValueToAdd
- the value to add to the array
RepositoryException
- if any of the arguments are invalid, the
given property does not evaluate to a array, or an error occurs adding
the item to the arraypublic void addArrayPropertyValueAtIndex(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToAdd, int pIndex) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to set the property onpItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the array property to add a
value topValueToAdd
- the value to add to the arraypIndex
- the index to add the value at
RepositoryException
- if any of the arguments are invalid, the
given property does not evaluate to a array, or an error occurs adding
the item to the arraypublic void removeArrayPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pValueToRemove) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the array property to remove a
property value frompValueToRemove
- the value to remove from the array. This will
be the first occurrance of the item in the array
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the arraypublic void removeArrayPropertyValueAtIndex(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, int pIndex) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to remove the property value frompItemDescriptorName
- the item type of the item to remove the
property value frompRepositoryId
- the id of the item to remove the property value
frompPropertyName
- the name of the array property to remove a
property value frompIndex
- the index of the element to remove
RepositoryException
- if any of the arguments are invalid,
or an error occurs removing the item from the arraypublic java.lang.String[] getPropertyNamesForItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName) throws RepositoryException, java.rmi.RemoteException
String [] names = getPropertyNamesForItem (
"/atg/userprofiling/ProfileAdapterRepository,
"user"
);
pRepositoryPath
- Nucleus path to the Repository to be inspected.pItemDescriptorName
- The item descriptor name for the given repository.
RepositoryException
java.rmi.RemoteException
public void setPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.Object pPropertyValue) throws RepositoryException
pPropertyName
to pPropertyValue
on
the item specified by pRepositoryId
found in the given
repository
pRepositoryPath
- the nucleus path of the repository where the
item livespItemDescriptorName
- the item type of the item to set the property
onpRepositoryId
- the id of the item to set the property onpPropertyName
- the name of the property to setpPropertyValue
- the value to set the property to
RepositoryException
- if the item to set the property on
cannot be found, or there is an error setting the value for the
given propertypublic java.lang.Object getPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to get the property value frompItemDescriptorName
- the type of the item to getpRepositoryId
- the id of the item to getpPropertyName
- the name of the property whose value is to
be retrieved
RepositoryException
- if an error occurs retrieving the
propertypublic java.lang.Object getMapPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRepositoryId, java.lang.String pPropertyName, java.lang.String pKey) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that contains
the item to get the map property value frompItemDescriptorName
- the type of the item to getpRepositoryId
- the id of the item to getpPropertyName
- the name of the map property whose value is to
be retrievedpKey
- the key of the entry to retrieve
RepositoryException
- if an error occurs retrieving the
propertypublic java.lang.Object translatePropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pPropertyName, java.lang.String pRepositoryId, java.lang.Object pPassedInValue) throws RepositoryException
pRepositoryPath
- the nucleus path of the repository that
contains the propertypItemDescriptorName
- the name of the descriptor that contains
the propertypPropertyName
- the name of the propertypRepositoryId
- the id of the user whose property is being set
or retrievedpPassedInValue
- the given value before translation
RepositoryException
- if an error occursprotected javax.transaction.Transaction ensureTransaction()
protected void commitTransaction()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |