Cleanup of JavaScript code formatting in Groups REST API.

Also fix up nonsense tags in related WebScript description fields.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@14764 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Kevin Roast
2009-06-17 12:40:49 +00:00
parent 423da7eb22
commit ad05edcbe9
14 changed files with 230 additions and 227 deletions

View File

@@ -4,7 +4,7 @@
Remove an authority (USER or GROUP) from a group. A user will not be deleted by this method. Remove an authority (USER or GROUP) from a group. A user will not be deleted by this method.
<br /> <br />
You must have "administrator" privileges to alter a group. You must have "administrator" privileges to alter a group.
</br /> <br />
]]> ]]>
</description> </description>
<url>/api/groups/{shortGroupName}/children/{fullAuthorityName}</url> <url>/api/groups/{shortGroupName}/children/{fullAuthorityName}</url>

View File

@@ -1,22 +1,22 @@
/** /**
* remove authority from group * Remove authority from group
*/ */
function main () function main ()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var fullAuthorityName = urlElements[2]; var fullAuthorityName = urlElements[2];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group == null) if (group == null)
{ {
// Group cannot be found // Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist."); status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return; return;
} }
group.removeAuthority(fullAuthorityName); group.removeAuthority(fullAuthorityName);
} }
main(); main();

View File

@@ -1,42 +1,44 @@
// get children /**
function main () * Get children
{ */
var urlElements = url.extension.split("/"); function main()
var shortName = urlElements[0]; {
var urlElements = url.extension.split("/");
var authorityType = args["authorityType"]; var shortName = urlElements[0];
var group = groups.getGroup(shortName); var authorityType = args["authorityType"];
if (group == null)
{ var group = groups.getGroup(shortName);
// Group cannot be found if (group == null)
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist."); {
return; // Group cannot be found
} status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return;
model.group = group; }
if(authorityType != null) model.group = group;
{
if(!authorityType.match("[GROUP|USER]")) if (authorityType != null)
{ {
status.setCode(status.STATUS_BAD_REQUEST, "The authorityType argument has does not have a correct value."); if (!authorityType.match("[GROUP|USER]"))
return; {
} status.setCode(status.STATUS_BAD_REQUEST, "The authorityType argument has does not have a correct value.");
if(authorityType == "GROUP") return;
{ }
model.children = group.getChildGroups(); if (authorityType == "GROUP")
} {
if(authorityType == "USER") model.children = group.getChildGroups();
{ }
model.children = group.getChildUsers(); if (authorityType == "USER")
} {
} model.children = group.getChildUsers();
else }
{ }
model.children = group.getChildAuthorities(); else
} {
model.children = group.getChildAuthorities();
}
} }
main(); main();

View File

@@ -1,46 +1,45 @@
/** /**
* Link groups or users to group. * Link groups or users to group.
* *
* Will create sub-groups if they don't already exist. * Will create sub-groups if they don't already exist.
*/ */
function main () function main()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var fullAuthorityName = urlElements[2]; var fullAuthorityName = urlElements[2];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
var GROUP_PREFIX = "GROUP_"; var GROUP_PREFIX = "GROUP_";
if (group == null)
{
// Parent Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return;
}
if (fullAuthorityName.match("^" + GROUP_PREFIX + "*"))
{
var subGroupName = fullAuthorityName.substr(GROUP_PREFIX.length);
var child = groups.getGroup(subGroupName);
// This is a group authority
if(child == null)
{
// child does not exist
child = group.createGroup(subGroupName, subGroupName);
status.code = status.STATUS_CREATED;
model.group = child;
return;
}
}
// Link an existing group or user
group.addAuthority(fullAuthorityName);
status.code = status.STATUS_OK;
model.group
if (group == null)
{
// Parent Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return;
}
if (fullAuthorityName.match("^" + GROUP_PREFIX + "*"))
{
var subGroupName = fullAuthorityName.substr(GROUP_PREFIX.length);
var child = groups.getGroup(subGroupName);
// This is a group authority
if(child == null)
{
// child does not exist
child = group.createGroup(subGroupName, subGroupName);
status.code = status.STATUS_CREATED;
model.group = child;
return;
}
}
// Link an existing group or user
group.addAuthority(fullAuthorityName);
status.code = status.STATUS_OK;
model.group
} }
main(); main();

View File

@@ -2,20 +2,20 @@
* Get group * Get group
*/ */
function main () function main()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group == null) if (group == null)
{ {
// Group cannot be found // Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist."); status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return; return;
} }
model.group = group; model.group = group;
} }
main(); main();

View File

@@ -1,26 +1,26 @@
// update group /**
* Update group
*/
function main () function main()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group == null) if (group == null)
{ {
// Group cannot be found // Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist."); status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return; return;
} }
if (json.has("displayName") == true) if (json.has("displayName") == true)
{ {
group.setDisplayName(json.get("displayName")); group.setDisplayName(json.get("displayName"));
} }
model.group = group; model.group = group;
} }
main(); main();

View File

@@ -4,7 +4,7 @@
Delete a group and all its dependents. Delete a group and all its dependents.
<br /> <br />
You must have "administrator" privileges to delete a group. You must have "administrator" privileges to delete a group.
</br /> <br />
]]> ]]>
</description> </description>
<url>/api/groups/{shortName}</url> <url>/api/groups/{shortName}</url>

View File

@@ -1,21 +1,21 @@
// delete group /**
* Delete group
*/
function main () function main()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group == null) if (group == null)
{ {
// Group cannot be found // Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist."); status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return; return;
} }
group.deleteGroup();
group.deleteGroup();
} }
main(); main();

View File

@@ -1,6 +1,6 @@
/** /**
* List/Search groups * List/Search groups
*/ */
function main () function main ()
{ {

View File

@@ -1,34 +1,37 @@
// get parents /**
* Get parent groups
*/
function main () function main ()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var level = args["level"]; var level = args["level"];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group == null) if (group == null)
{ {
// Group cannot be found // Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group: " + shortName + " does not exist."); status.setCode(status.STATUS_NOT_FOUND, "The group: " + shortName + " does not exist.");
return; return;
} }
model.group = group; model.group = group;
if (level != null) if (level != null)
{ {
if (!level.match("[ALL]")) if (!level.match("[ALL]"))
{ {
status.setCode(status.STATUS_BAD_REQUEST, "The level argument has does not have a correct value."); status.setCode(status.STATUS_BAD_REQUEST, "The level argument has does not have a correct value.");
return; return;
} }
model.parents = group.getAllParentGroups(); model.parents = group.getAllParentGroups();
} }
else else
{ {
model.parents = group.getParentGroups(); model.parents = group.getParentGroups();
} }
} }
main(); main();

View File

@@ -4,7 +4,7 @@
Delete a root group and all its dependents. Delete a root group and all its dependents.
<br /> <br />
You must have "administrator" privileges to delete a group. You must have "administrator" privileges to delete a group.
</br /> <br />
]]> ]]>
</description> </description>
<url>/api/rootgroups/{shortName}</url> <url>/api/rootgroups/{shortName}</url>

View File

@@ -1,21 +1,21 @@
// delete group /**
* Delete group
*/
function main () function main()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group == null) if (group == null)
{ {
// Group cannot be found // Group cannot be found
status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist."); status.setCode(status.STATUS_NOT_FOUND, "The group :" + shortName + ", does not exist.");
return; return;
} }
group.deleteGroup();
group.deleteGroup();
} }
main(); main();

View File

@@ -4,22 +4,19 @@
function main () function main ()
{ {
// Get the args // Get the args
var shortNameFilter = args["shortNameFilter"]; var shortNameFilter = args["shortNameFilter"];
var includeInternalStr = args["includeInternal"]; var includeInternalStr = args["includeInternal"];
if(shortNameFilter == null) if (shortNameFilter == null)
{ {
shortNameFilter = ""; shortNameFilter = "";
} }
var includeInternal = includeInternalStr == "true" ? true : false; var includeInternal = includeInternalStr == "true" ? true : false;
// Do the search // Do the search
model.groups = groups.searchRootGroups(shortNameFilter, includeInternal); model.groups = groups.searchRootGroups(shortNameFilter, includeInternal);
} }
main(); main();

View File

@@ -1,27 +1,29 @@
// Create new rootgroup. /**
* Create new root group.
*/
function main () function main()
{ {
var urlElements = url.extension.split("/"); var urlElements = url.extension.split("/");
var shortName = urlElements[0]; var shortName = urlElements[0];
var group = groups.getGroup(shortName); var group = groups.getGroup(shortName);
if (group != null) if (group != null)
{ {
// Group already exists // Group already exists
status.setCode(status.STATUS_BAD_REQUEST, "The root group :" + shortName + ", already exixts."); status.setCode(status.STATUS_BAD_REQUEST, "The root group :" + shortName + ", already exixts.");
return; return;
} }
var displayName = shortName; var displayName = shortName;
if (json.has("displayName") == true) if (json.has("displayName") == true)
{ {
displayName = json.get("displayName"); displayName = json.get("displayName");
} }
model.group = groups.createRootGroup(shortName, displayName); model.group = groups.createRootGroup(shortName, displayName);
status.code = status.STATUS_CREATED; status.code = status.STATUS_CREATED;
} }
main(); main();