Package com.xwiki.admintools.security

Class RightsResult

java.lang.Object

com.xwiki.admintools.security.RightsResult

@Unstable
public class RightsResult
extends Object

Stores needed information from the groups and users rights processing.

Since:

1.2

Version:

$Id$

Constructor Summary

Constructors

Constructor	Description
RightsResult()	Default constructor.
RightsResult(String type)	Constructor with type parameter.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
org.xwiki.model.reference.DocumentReference	getDocReference()	Retrieves the reference of the document where rights are stored.
String	getEntity()	Retrieves the entity for which rights are checked.
String	getLevel()	Get the stored level of security.
String	getPolicy()	Get the rights level policy.
String	getSpace()	Get the space where the document is located.
String	getType()	Get the type of rights.
int	hashCode()
void	setDocReference(org.xwiki.model.reference.DocumentReference docReference)	See getDocReference().
void	setEntity(String entity)	See getEntity().
void	setLevel(String level)	See getLevel().
void	setPolicy(String policy)	See getPolicy().
void	setSpace(String space)	See getSpace().
void	setType(String type)	See getType().

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RightsResult

public RightsResult()

Default constructor.

RightsResult

public RightsResult(String type)

Constructor with type parameter.

Parameters:

type - the type of the stored rights info.

Method Detail

getLevel

public String getLevel()

Get the stored level of security.

Returns:

the level of security.

setLevel

public void setLevel(String level)

See getLevel().

Parameters:

level - the level of security.

getDocReference

public org.xwiki.model.reference.DocumentReference getDocReference()

Retrieves the reference of the document where rights are stored.

Returns:

the document reference containing the rights.

setDocReference

public void setDocReference(org.xwiki.model.reference.DocumentReference docReference)

See getDocReference().

Parameters:

docReference - the document reference containing the rights.

getEntity

public String getEntity()

Retrieves the entity for which rights are checked.

Returns:

the entity being checked for rights.

setEntity

public void setEntity(String entity)

See getEntity().

Parameters:

entity - the entity to check rights for.

getPolicy

public String getPolicy()

Get the rights level policy. Used values are Allowed and Denied.

Returns:

the rights level policy.

setPolicy

public void setPolicy(String policy)

See getPolicy().

Parameters:

policy - the rights level policy.

getSpace

public String getSpace()

Get the space where the document is located.

Returns:

the space where the document is located.

setSpace

public void setSpace(String space)

See getSpace().

Parameters:

space - the space where the document is located.

getType

public String getType()

Get the type of rights. Used values are Global, Space and Page.

Returns:

the type of rights.

setType

public void setType(String type)

See getType().

Parameters:

type - the type of rights.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object