Package com.tapkey.mobile.model

Class UserGrant

java.lang.Object

com.tapkey.mobile.model.UserGrant

public class UserGrant
extends Object

A Grant from the perspective of the receiving user.

Constructor Summary

Constructors

Constructor	Description
UserGrant(String id, Date validFrom, Date validBefore, String timeRestrictionIcal, Owner owner, BoundLock boundLock, PermissionDetails permissionDetails)

Method Summary

Modifier and Type	Method	Description
BoundLock	getBoundLock()	The locking device the grant relates to.
String	getId()	This Grant's ID.
Owner	getOwner()	The owner account, the grant belongs to.
PermissionDetails	getPermissionDetails()	Details about the actions the client is allowed to perform.
String	getTimeRestrictionIcal()	An RFC 5545 (iCalendar) compliant string, describing the time restriction that applies to this grant.
Date	getValidBefore()	Date when the access permission expires.
Date	getValidFrom()	Date from when on access is granted.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserGrant

public UserGrant(String id,
                 Date validFrom,
                 Date validBefore,
                 String timeRestrictionIcal,
                 Owner owner,
                 BoundLock boundLock,
                 PermissionDetails permissionDetails)

Method Detail

getId

public String getId()

This Grant's ID.

Returns:

the id of the grant.

getValidFrom

public Date getValidFrom()

Date from when on access is granted. If this value is null, there is no restriction regarding the beginning of the validity period.

Returns:

the Date from when access is granted.

getValidBefore

public Date getValidBefore()

Date when the access permission expires. If this valid is null, the validity period is unrestricted regarding it's end.

Returns:

theDate when the access permission expires.

getTimeRestrictionIcal

public String getTimeRestrictionIcal()

An RFC 5545 (iCalendar) compliant string, describing the time restriction that applies to this grant. The string represents a VCALENDAR structure, containing exactly one VEVENT structure. The certificate may be used at the times described within the VEVENT structure. This restriction is applied additionally to the validFrom, validBefore restrictions.

Returns:

the time restriction ICAL string.

getOwner

public Owner getOwner()

The owner account, the grant belongs to.

Returns:

the Owner Account the grant belongs to.

getBoundLock

public BoundLock getBoundLock()

The locking device the grant relates to.

Returns:

the locking device the grant relates to.

getPermissionDetails

public PermissionDetails getPermissionDetails()

Details about the actions the client is allowed to perform.

Returns:

details about the actions the client is allowed to perform.