com.businessobjects.dsws.session
Interface UserRight

public interface UserRight

The UserRight interface is a session based rights of the current logged in used. Web Services provide the following types of user rights.

• Rights on a user but not an object. For example, CHANGE_PASSWORD.
• Rights on resource types. For example, REFRESH_DOCUMENT.

An array of the current users UserRights can be retrieved using the com.businessobjects.dsws.session.SessionInfo#getUserRights() function.

Example: Get the rights of the user.

 String endPointURL = "http://bo-priyanka:8080/dswsbobje/services/Session";
 com.businessobjects.dsws.Connection con = new Connection(new URL(endPointURL));
 Session objSession = new Session(con);
 EnterpriseCredential ec = EnterpriseCredential.Factory.newInstance();
 ec.setLogin("Administrator");
 ec.setPassword("");
 ec.setAuthType("secEnterprise");
 SessionInfo sessionInfo = objSession.login(ec);
 UserRight[] objUserRights = sessionInfo.getUserRights();
 for(int i=0;i< objUserRights.length;i++)
 {
   UserRight objUserRight= objUserRights[i];
   String strUserRightName = objUserRight.getName();
   out.print(strUserRightName);
 }
 

Nested Class Summary

static class

UserRight.Factory A class with methods for creating instances of the UserRight type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getName() Return the name of the UserRight.
boolean	getValue() Returns the Value attribute.
void	setName(java.lang.String name) Internal Use Only.
void	setValue(boolean value) Sets the Value attribute.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetValue() Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetValue(org.apache.xmlbeans.XmlBoolean value) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getName

java.lang.String getName()

Return the name of the UserRight.

Returns:

a String containing the name of the current UserRight. For example, CHANGE_PASSWORD.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getValue

boolean getValue()

Returns the Value attribute.

Returns:

the Value attribute.

xgetValue

org.apache.xmlbeans.XmlBoolean xgetValue()

Internal Use Only.

setValue

void setValue(boolean value)

Sets the Value attribute.

Parameters:

value - the new Value attribute.

xsetValue

void xsetValue(org.apache.xmlbeans.XmlBoolean value)

Internal Use Only.