Permissions (omero-blitz 5.7.4 API)

java.lang.Object
- Ice.ObjectImpl
- - omero.model.Permissions

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _PermissionsOperations, _PermissionsOperationsNC

Direct Known Subclasses:

_PermissionsTie, PermissionsI
```
public abstract class Permissions
extends Ice.ObjectImpl
implements _PermissionsOperations, _PermissionsOperationsNC
```
Row-level permissions definition available on every OMERO.blitz type. Represents a similar logic to the Unix filesystem.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`__ids`
`protected java.util.List<java.lang.String>`	`extendedRestrictions` Further restrictions which are specified by services at runtime.
`protected long`	`perm1` Internal representation.
`protected boolean[]`	`restrictions` Restrictions placed on the current object for the current user.
`static long`	`serialVersionUID`

Fields inherited from interface Ice.Object
ice_staticId

Constructor Summary

Constructors
Constructor and Description

Permissions()

Permissions(boolean[] restrictions, java.util.List<java.lang.String> extendedRestrictions, long perm1)

Constructors
Constructor and Description
`Permissions()`
`Permissions(boolean[] restrictions, java.util.List<java.lang.String> extendedRestrictions, long perm1)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Ice.DispatchStatus`	`___canAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___canChgrp(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___canChown(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___canDelete(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___canEdit(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___canLink(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getPerm1(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isDisallow(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isGroupAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isGroupRead(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isGroupWrite(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isRestricted(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isUserAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isUserRead(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isUserWrite(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isWorldAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isWorldRead(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isWorldWrite(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setGroupAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setGroupRead(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setGroupWrite(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setPerm1(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setUserAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setUserRead(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setUserWrite(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setWorldAnnotate(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setWorldRead(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___setWorldWrite(Permissions __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`Ice.DispatchStatus`	`__dispatch(IceInternal.Incoming in, Ice.Current __current)`
`protected void`	`__readImpl(IceInternal.BasicStream __is)`
`protected void`	`__writeImpl(IceInternal.BasicStream __os)`
`boolean`	`canAnnotate()` Whether the current user has permissions for annotating this object.
`boolean`	`canChgrp()` Whether the current user has the ""chgrp"" permissions for this object.
`boolean`	`canChown()` Whether the current user has the ""chown"" permissions for this object.
`boolean`	`canDelete()` Whether the current user has the ""delete"" permissions for this object.
`boolean`	`canEdit()` Whether the current user has the ""edit"" permissions for this object.
`boolean`	`canLink()` Whether the current user has the ""link"" permissions for this object.
`Permissions`	`clone()`
`long`	`getPerm1()` Do not use!
`java.lang.String`	`ice_id()`
`java.lang.String`	`ice_id(Ice.Current __current)`
`java.lang.String[]`	`ice_ids()`
`java.lang.String[]`	`ice_ids(Ice.Current __current)`
`boolean`	`ice_isA(java.lang.String s)`
`boolean`	`ice_isA(java.lang.String s, Ice.Current __current)`
`static java.lang.String`	`ice_staticId()`
`boolean`	`isDisallow(int restriction)` The basis for the other canX() methods.
`boolean`	`isGroupAnnotate()`
`boolean`	`isGroupRead()`
`boolean`	`isGroupWrite()`
`boolean`	`isRestricted(java.lang.String restriction)` Returns true if the given argument is present in the extendedRestrictions set.
`boolean`	`isUserAnnotate()`
`boolean`	`isUserRead()`
`boolean`	`isUserWrite()`
`boolean`	`isWorldAnnotate()`
`boolean`	`isWorldRead()`
`boolean`	`isWorldWrite()`
`void`	`setGroupAnnotate(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setGroupRead(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setGroupWrite(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setPerm1(long value)` Do not use! Throws `ClientError` if mutation not allowed.
`void`	`setUserAnnotate(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setUserRead(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setUserWrite(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setWorldAnnotate(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setWorldRead(boolean value)` Throws `ClientError` if mutation not allowed.
`void`	`setWorldWrite(boolean value)` Throws `ClientError` if mutation not allowed.

Methods inherited from class Ice.ObjectImpl
___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface omero.model._PermissionsOperations
canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getPerm1, isDisallow, isGroupAnnotate, isGroupRead, isGroupWrite, isRestricted, isUserAnnotate, isUserRead, isUserWrite, isWorldAnnotate, isWorldRead, isWorldWrite, setGroupAnnotate, setGroupRead, setGroupWrite, setPerm1, setUserAnnotate, setUserRead, setUserWrite, setWorldAnnotate, setWorldRead, setWorldWrite

Field Detail
- __ids
```
public static final java.lang.String[] __ids
```
- restrictions
```
protected boolean[] restrictions
```
  Restrictions placed on the current object for the current user. Indexes into this array are based on constants in the omero.constants.permissions module. If a restriction index is not present, then it is safe to assume that there is no such restriction. If null, this should be assumed to have no restrictions.
- extendedRestrictions
```
protected java.util.List<java.lang.String> extendedRestrictions
```
  Further restrictions which are specified by services at runtime. Individual service methods will specify which strings MAY NOT be present in this field for execution to be successful. For example, if an Image contains a ""DOWNLOAD"" restriction, then an attempt to call omero.api.RawFileStore.read will fail with an SecurityViolation.
- perm1
```
protected long perm1
```
  Internal representation. May change! To make working with this object more straight-forward accessors are provided for the perm1 instance though it is protected, though NO GUARANTEES are made on the representation.
- serialVersionUID
```
public static final long serialVersionUID
```
  See Also:
  
  Constant Field Values

Constructor Detail

Permissions
```
public Permissions()
```

Permissions

public Permissions(boolean[] restrictions,
                   java.util.List<java.lang.String> extendedRestrictions,
                   long perm1)

Method Detail

ice_isA
```
public boolean ice_isA(java.lang.String s)
```
Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:: ice_isA in interface Ice.Object
Overrides:: ice_isA in class Ice.ObjectImpl

ice_ids
```
public java.lang.String[] ice_ids()
```
Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids
```
public java.lang.String[] ice_ids(Ice.Current __current)
```
Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id
```
public java.lang.String ice_id()
```
Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id
```
public java.lang.String ice_id(Ice.Current __current)
```
Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

canAnnotate
```
public final boolean canAnnotate()
```
Whether the current user has permissions for annotating this object. The fact that the user has this object in hand already identifies that it's readable.

Specified by:

canAnnotate in interface _PermissionsOperationsNC

canChgrp
```
public final boolean canChgrp()
```
Whether the current user has the ""chgrp"" permissions for this object. This allows them to move it to a different group. The fact that the user has this object in hand already identifies that it's readable.

Specified by:

canChgrp in interface _PermissionsOperationsNC

canChown
```
public final boolean canChown()
```
Whether the current user has the ""chown"" permissions for this object. This allows them to give it to a different user. The fact that the user has this object in hand already identifies that it's readable.

Specified by:

canChown in interface _PermissionsOperationsNC

canDelete
```
public final boolean canDelete()
```
Whether the current user has the ""delete"" permissions for this object. The fact that the user has this object in hand already identifies that it's readable.

Specified by:

canDelete in interface _PermissionsOperationsNC

canEdit
```
public final boolean canEdit()
```
Whether the current user has the ""edit"" permissions for this object. This includes changing the values of the object. The fact that the user has this object in hand already identifies that it's readable.

Specified by:

canEdit in interface _PermissionsOperationsNC

canLink
```
public final boolean canLink()
```
Whether the current user has the ""link"" permissions for this object. This includes adding it to data graphs. The fact that the user has this object in hand already identifies that it's readable.

Specified by:

canLink in interface _PermissionsOperationsNC

getPerm1
```
public final long getPerm1()
```
Do not use!

Specified by:

getPerm1 in interface _PermissionsOperationsNC

isDisallow
```
public final boolean isDisallow(int restriction)
```
The basis for the other canX() methods. If the restriction at the given offset in the restriction array is true, then this method returns true (otherwise false) and the canX() methods return the opposite, i.e. isDisallow(ANNOTATERESTRICTION) == ! canAnnotate()

Specified by:

isDisallow in interface _PermissionsOperationsNC

isGroupAnnotate
```
public final boolean isGroupAnnotate()
```
Specified by:

isGroupAnnotate in interface _PermissionsOperationsNC

isGroupRead
```
public final boolean isGroupRead()
```
Specified by:

isGroupRead in interface _PermissionsOperationsNC

isGroupWrite
```
public final boolean isGroupWrite()
```
Specified by:

isGroupWrite in interface _PermissionsOperationsNC

isRestricted
```
public final boolean isRestricted(java.lang.String restriction)
```
Returns true if the given argument is present in the extendedRestrictions set. This implies that some service-specific behavior is disallowed.

Specified by:

isRestricted in interface _PermissionsOperationsNC

isUserAnnotate
```
public final boolean isUserAnnotate()
```
Specified by:

isUserAnnotate in interface _PermissionsOperationsNC

isUserRead
```
public final boolean isUserRead()
```
Specified by:

isUserRead in interface _PermissionsOperationsNC

isUserWrite
```
public final boolean isUserWrite()
```
Specified by:

isUserWrite in interface _PermissionsOperationsNC

isWorldAnnotate
```
public final boolean isWorldAnnotate()
```
Specified by:

isWorldAnnotate in interface _PermissionsOperationsNC

isWorldRead
```
public final boolean isWorldRead()
```
Specified by:

isWorldRead in interface _PermissionsOperationsNC

isWorldWrite
```
public final boolean isWorldWrite()
```
Specified by:

isWorldWrite in interface _PermissionsOperationsNC

setGroupAnnotate
```
public final void setGroupAnnotate(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setGroupAnnotate in interface _PermissionsOperationsNC

setGroupRead
```
public final void setGroupRead(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setGroupRead in interface _PermissionsOperationsNC

setGroupWrite
```
public final void setGroupWrite(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setGroupWrite in interface _PermissionsOperationsNC

setPerm1
```
public final void setPerm1(long value)
```
Do not use! Throws ClientError if mutation not allowed.

Specified by:

setPerm1 in interface _PermissionsOperationsNC

setUserAnnotate
```
public final void setUserAnnotate(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setUserAnnotate in interface _PermissionsOperationsNC

setUserRead
```
public final void setUserRead(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setUserRead in interface _PermissionsOperationsNC

setUserWrite
```
public final void setUserWrite(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setUserWrite in interface _PermissionsOperationsNC

setWorldAnnotate
```
public final void setWorldAnnotate(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setWorldAnnotate in interface _PermissionsOperationsNC

setWorldRead
```
public final void setWorldRead(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setWorldRead in interface _PermissionsOperationsNC

setWorldWrite
```
public final void setWorldWrite(boolean value)
```
Throws ClientError if mutation not allowed.

Specified by:

setWorldWrite in interface _PermissionsOperationsNC

___getPerm1

public static Ice.DispatchStatus ___getPerm1(Permissions __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___setPerm1

public static Ice.DispatchStatus ___setPerm1(Permissions __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___isDisallow

public static Ice.DispatchStatus ___isDisallow(Permissions __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___isRestricted

public static Ice.DispatchStatus ___isRestricted(Permissions __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___canAnnotate

public static Ice.DispatchStatus ___canAnnotate(Permissions __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___canEdit

public static Ice.DispatchStatus ___canEdit(Permissions __obj,
                                            IceInternal.Incoming __inS,
                                            Ice.Current __current)

___canLink

public static Ice.DispatchStatus ___canLink(Permissions __obj,
                                            IceInternal.Incoming __inS,
                                            Ice.Current __current)

___canDelete

public static Ice.DispatchStatus ___canDelete(Permissions __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___canChgrp

public static Ice.DispatchStatus ___canChgrp(Permissions __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___canChown

public static Ice.DispatchStatus ___canChown(Permissions __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___isUserRead

public static Ice.DispatchStatus ___isUserRead(Permissions __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___isUserAnnotate

public static Ice.DispatchStatus ___isUserAnnotate(Permissions __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___isUserWrite

public static Ice.DispatchStatus ___isUserWrite(Permissions __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___isGroupRead

public static Ice.DispatchStatus ___isGroupRead(Permissions __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___isGroupAnnotate

public static Ice.DispatchStatus ___isGroupAnnotate(Permissions __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___isGroupWrite

public static Ice.DispatchStatus ___isGroupWrite(Permissions __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___isWorldRead

public static Ice.DispatchStatus ___isWorldRead(Permissions __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___isWorldAnnotate

public static Ice.DispatchStatus ___isWorldAnnotate(Permissions __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___isWorldWrite

public static Ice.DispatchStatus ___isWorldWrite(Permissions __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___setUserRead

public static Ice.DispatchStatus ___setUserRead(Permissions __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___setUserAnnotate

public static Ice.DispatchStatus ___setUserAnnotate(Permissions __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___setUserWrite

public static Ice.DispatchStatus ___setUserWrite(Permissions __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___setGroupRead

public static Ice.DispatchStatus ___setGroupRead(Permissions __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___setGroupAnnotate

public static Ice.DispatchStatus ___setGroupAnnotate(Permissions __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___setGroupWrite

public static Ice.DispatchStatus ___setGroupWrite(Permissions __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___setWorldRead

public static Ice.DispatchStatus ___setWorldRead(Permissions __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___setWorldAnnotate

public static Ice.DispatchStatus ___setWorldAnnotate(Permissions __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___setWorldWrite

public static Ice.DispatchStatus ___setWorldWrite(Permissions __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:: __dispatch in interface Ice.Object
Overrides:: __dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:: __writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:: __readImpl in class Ice.ObjectImpl

clone
```
public Permissions clone()
```
Specified by:

clone in interface Ice.Object

Overrides:

clone in class Ice.ObjectImpl

Class Permissions

Field Summary

Fields inherited from interface Ice.Object

Constructor Summary

Method Summary

Methods inherited from class Ice.ObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface omero.model._PermissionsOperations

Field Detail

__ids

restrictions

extendedRestrictions

perm1

serialVersionUID

Constructor Detail

Permissions

Permissions

Method Detail

ice_isA

ice_isA

ice_ids

ice_ids

ice_id

ice_id

ice_staticId

canAnnotate

canChgrp

canChown

canDelete

canEdit

canLink

getPerm1

isDisallow

isGroupAnnotate

isGroupRead

isGroupWrite

isRestricted

isUserAnnotate

isUserRead

isUserWrite

isWorldAnnotate

isWorldRead

isWorldWrite

setGroupAnnotate

setGroupRead

setGroupWrite

setPerm1

setUserAnnotate

setUserRead

setUserWrite

setWorldAnnotate

setWorldRead

setWorldWrite

___getPerm1

___setPerm1

___isDisallow

___isRestricted

___canAnnotate

___canEdit

___canLink

___canDelete

___canChgrp

___canChown

___isUserRead

___isUserAnnotate

___isUserWrite

___isGroupRead

___isGroupAnnotate

___isGroupWrite

___isWorldRead

___isWorldAnnotate

___isWorldWrite

___setUserRead

___setUserAnnotate

___setUserWrite

___setGroupRead

___setGroupAnnotate

___setGroupWrite

___setWorldRead

___setWorldAnnotate