net.bluemind.directory.api

Interface IOrgUnits

All Known Implementing Classes:

OrgUnits

@Path(value="/directory/_ou/{domain}")
public interface IOrgUnits

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String uid, OrgUnit value) Create organizational unit
void	delete(java.lang.String uid) Delete organizational unit
java.util.Set<java.lang.String>	getAdministratorRoles(java.lang.String uid, java.lang.String dirUid, java.util.List<java.lang.String> groups)
java.util.Set<java.lang.String>	getAdministrators(java.lang.String uid)
java.util.List<ItemValue<OrgUnit>>	getChildren(java.lang.String uid)
ItemValue<OrgUnit>	getComplete(java.lang.String uid) Fetch organizational unit by uid
OrgUnitPath	getPath(java.lang.String uid) Fetch organizational unit path by uid
java.util.List<OrgUnitPath>	listByAdministrator(java.lang.String administrator, java.util.List<java.lang.String> groups)
void	removeAdministrator(java.lang.String administrator)
java.util.List<OrgUnitPath>	search(OrgUnitQuery query) Search OrgUnitPath
void	setAdministratorRoles(java.lang.String uid, java.lang.String dirUid, java.util.Set<java.lang.String> roles)
void	update(java.lang.String uid, OrgUnit value) Update organizational unit

Method Detail

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<OrgUnit> getComplete(@PathParam(value="uid")
                                                                   java.lang.String uid)

Fetch organizational unit by uid

Returns:

ItemValue of (OrgUnit

getChildren

@GET
 @Path(value="{uid}/_children")
java.util.List<ItemValue<OrgUnit>> getChildren(@PathParam(value="uid")
                                                                                    java.lang.String uid)

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       OrgUnit value)

Create organizational unit

Parameters:

uid - uid

value - OrgUnit

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        OrgUnit value)

Update organizational unit

Parameters:

uid - uid

value - OrgUnit

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)

Delete organizational unit

Parameters:

uid - uid

getPath

@GET
 @Path(value="{uid}/path")
OrgUnitPath getPath(@PathParam(value="uid")
                                                    java.lang.String uid)

Fetch organizational unit path by uid

Parameters:

uid - OU uid

Returns:

ItemValue of (OrgUnitPath

search

@POST
 @Path(value="_search")
java.util.List<OrgUnitPath> search(OrgUnitQuery query)

Search OrgUnitPath

Parameters:

query -

Returns:

setAdministratorRoles

@POST
 @Path(value="{uid}/{dirUid}/_set")
void setAdministratorRoles(@PathParam(value="uid")
                                                                     java.lang.String uid,
                                                                     @PathParam(value="dirUid")
                                                                     java.lang.String dirUid,
                                                                     java.util.Set<java.lang.String> roles)

getAdministratorRoles

@POST
 @Path(value="{uid}/{dirUid}")
java.util.Set<java.lang.String> getAdministratorRoles(@PathParam(value="uid")
                                                                                           java.lang.String uid,
                                                                                           @PathParam(value="dirUid")
                                                                                           java.lang.String dirUid,
                                                                                           java.util.List<java.lang.String> groups)

getAdministrators

@GET
 @Path(value="{uid}/_administrators")
java.util.Set<java.lang.String> getAdministrators(@PathParam(value="uid")
                                                                                             java.lang.String uid)

listByAdministrator

@POST
 @Path(value="_byAdmin")
java.util.List<OrgUnitPath> listByAdministrator(@QueryParam(value="administrator")
                                                                               java.lang.String administrator,
                                                                               java.util.List<java.lang.String> groups)

removeAdministrator

@DELETE
 @Path(value="_deleteadmin")
void removeAdministrator(@QueryParam(value="administrator")
                                                              java.lang.String administrator)