com.microstrategy.usher

Class KeyParam

java.lang.Object

com.microstrategy.usher.KeyParam

public abstract class KeyParam
extends java.lang.Object

The KeyParam abstract class wraps fields related to keys. It is used to attempt physical access using KeyManager.access(KeyParam, SingleCallback), among other actions.

Method Summary

Modifier and Type	Method and Description
abstract int	badgeId() Returns an int of the identification number of the badge.
static KeyParam	build(int keyId, int badgeId) Constructor for a KeyParam object with the keyId and badgeId set.
static KeyParam	build(int keyId, int badgeId, java.lang.String resourceId) Constructor for a KeyParam object with the keyId, badgeId, and resourceId set.
abstract int	keyId() Returns an int of the identification number of the key.
abstract java.lang.String	resourceId() Returns a String of the identification number of the resource.

Methods inherited from class java.lang.Object

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

Method Detail

build

public static KeyParam build(int keyId,
                             int badgeId)

Constructor for a KeyParam object with the keyId and badgeId set. The orgId() is set to BadgeIdOrgIdEntity.INVALID_ORG_ID by default.

Parameters:

keyId - the identification number of the key

badgeId - the identification number of the badge

Returns:

a KeyParam object with the keyId and badgeId set.

build

public static KeyParam build(int keyId,
                             int badgeId,
                             java.lang.String resourceId)

Constructor for a KeyParam object with the keyId, badgeId, and resourceId set. The orgId() is set to BadgeIdOrgIdEntity.INVALID_ORG_ID by default.

Parameters:

keyId - the identification number of the key

badgeId - the identification number of the badge

resourceId - the identification number of the resource

Returns:

a KeyParam object with the keyId, badgeId, and resourceId set.

keyId

public abstract int keyId()

Returns an int of the identification number of the key.

Returns:

the identification number of the key.

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

resourceId

@Nullable
public abstract java.lang.String resourceId()

Returns a String of the identification number of the resource. May be null.

Returns:

the identification number of the resource.