Difference between revisions of "OKMPropertyGroup"

Revision as of 12:24, 21 October 2010 (view source) Pavila (talk | contribs) (→‎void setProperties(String token, String nodePath, String grpName, FormElement[] properties)) ← Older edit		Revision as of 12:26, 21 October 2010 (view source) Pavila (talk | contribs) (→‎boolean hasGroup(String token, String nodePath, String grpName)) Newer edit →
Line 121:		Line 121:
	== boolean hasGroup(String token, String nodePath, String grpName) ==		== boolean hasGroup(String token, String nodePath, String grpName) ==
		+	Test if a node has a property group assigned
		+
		+	'''Parameters'''
		+	* ''token'' The session authorization token.
		+	* ''nodePath'' The path that identifies an unique node.
		+	* ''grpName'' The group name previously registered in the system.
		+
		+	'''Returns'''
		+	* True if the document has the given property group assigned, and false otherwise.
		+
		+	'''Throws'''
		+	* ''NoSuchGroupException'' If there is no such registered group name.
		+	* ''PathNotFoundException'' If there is no document in this repository path.
		+	* ''RepositoryException'' If there is any general repository problem.
		+
		+	'''Since'''
		+	* OpenKM 5.0
	[[Category: Webservices Guide]]		[[Category: Webservices Guide]]

---

Revision as of 12:26, 21 October 2010

Methods related to Property Groups.

void addGroup(String token, String nodePath, String grpName)

Add a property group to a document.

Parameters

• token The session authorization token.
• nodePath The path that identifies an unique node.
• grpName The group name previously registered in the system.

Returns

• None.

Throws

• NoSuchGroupException If there is no such registered group name.
• LockException Can't modify a locked document.
• PathNotFoundException If there is no document in this repository path.
• AccessDeniedException If there is any security problem: you can't modify the document because of lack of permissions.
• RepositoryException If there is any general repository problem.

Since

• OpenKM 4.1

void removeGroup(String token, String nodePath, String grpName)

Removes a property group from a document.

Parameters

• token The session authorization token.
• nodePath The path that identifies an unique node.
• grpName The group name previously registered in the system.

Returns

• None.

Throws

• NoSuchGroupException If there is no such registered group name.
• LockException Can't modify a locked document.
• PathNotFoundException If there is no document in this repository path.
• RepositoryException If there is any general repository problem.

Since

• OpenKM 4.1

PropertyGroup[] getGroups(String token, String nodePath)

Get groups assigned to a document.

Parameters

• token The session authorization token.
• nodePath The path that identifies an unique node.

Returns

• A list with all groups assigned to the document.

Throws

• NoSuchGroupException If there is no such registered group name.
• LockException Can't modify a locked document.
• PathNotFoundException If there is no document in this repository path.
• RepositoryException If there is any general repository problem.

Since

• OpenKM 4.1

PropertyGroup[] getAllGroups(String token)

Get all groups defined in the system.

Parameters

• token The session authorization token.

Returns

• A list with all groups registered in the system.

Throws

• RepositoryException If there is any general repository problem.

Since

• OpenKM 4.1

FormElement[] getProperties(String token, String nodePath, String grpName)

Get all properties defined in a document by group.

Parameters

• token The session authorization token.
• nodePath The path that identifies an unique node.
• grpName The group name previously registered in the system.

Returns

• A list with all properties defined in the group and its actual values.

Throws

• NoSuchGroupException If there is no such registered group name.
• PathNotFoundException If there is no document in this repository path.
• RepositoryException If there is any general repository problem.

Since

• OpenKM 4.1

void setProperties(String token, String nodePath, String grpName, FormElement[] properties)

Set group properties to a document.

Parameters

• token The session authorization token.
• nodePath The path that identifies an unique node.
• grpName The group name previously registered in the system.
• properties The property values.

Returns

• None.

Throws

• NoSuchPropertyException If there is no such registered category property.
• NoSuchGroupException If there is no such registered group name.
• LockException Can't modify a locked document.
• PathNotFoundException If there is no document in this repository path.
• AccessDeniedException If there is any security problem: you can't modify the document because of lack of permissions.
• RepositoryException If there is any general repository problem.

Since

• OpenKM 4.1

boolean hasGroup(String token, String nodePath, String grpName)

Test if a node has a property group assigned

Parameters

• token The session authorization token.
• nodePath The path that identifies an unique node.
• grpName The group name previously registered in the system.

Returns

• True if the document has the given property group assigned, and false otherwise.

Throws

• NoSuchGroupException If there is no such registered group name.
• PathNotFoundException If there is no document in this repository path.
• RepositoryException If there is any general repository problem.

Since

• OpenKM 5.0