Class OrganizationState

Represents the current organization state.

Hierarchy

OrganizationState

Index

Methods

Methods

getAccount

getAccount(accountId: AccountId): Account

- Defined in organization-context/src/organization-state.ts:184
Get account by id, or throw an error.

throws

error if account is not found

Parameters
- accountId: AccountId
Returns Account

account

getPolicies

getPolicies(policyType: PolicyType): Policy[]

- Defined in organization-context/src/organization-state.ts:76
Get policies by type, or throw an error if no policy type is found.

throws

error if no policy type is found

Parameters
- policyType: PolicyType
Returns Policy[]

policies of given type

getPoliciesAttachedToTarget

getPoliciesAttachedToTarget(policyType: string, targetId: OrgEntityId): PolicyName[]

- Defined in organization-context/src/organization-state.ts:143
Get names of policies of given type attached directly to a target.

Parameters
- policyType: string
- targetId: OrgEntityId
Returns PolicyName[]

names of policies of given type attached to a target

getPoliciesInheritedByTarget

getPoliciesInheritedByTarget(policyType: PolicyType, targetId: OrgEntityId): PolicyName[]

- Defined in organization-context/src/organization-state.ts:162
Get names of policies of given type inherited by a target.

Parameters
- policyType: PolicyType
- targetId: OrgEntityId
Returns PolicyName[]

names of policies of given type inherited by a target

getPolicy

getPolicy(policyType: PolicyType, policyName: PolicyName): Policy | null

- Defined in organization-context/src/organization-state.ts:92
Get a policy by type and name, or null if no matching policy is found.

Parameters
- policyType: PolicyType
- policyName: PolicyName
Returns Policy | null

policy of given type and name, or null if no matching policy is found

getPolicyId

getPolicyId(policyType: PolicyType, policyName: PolicyName): string

- Defined in organization-context/src/organization-state.ts:105
Get id of a policy by type and name, or throw an error if no matching policy is found.

throws

error if no policy is found

Parameters
- policyType: PolicyType
- policyName: PolicyName
Returns string

policy of given type and name

setPolicy

setPolicy(policyType: PolicyType, policyName: PolicyName, policy: Policy): void

- Defined in organization-context/src/organization-state.ts:123
Set policy.

Parameters
- policyType: PolicyType
- policyName: PolicyName
- policy: Policy
Returns void

Generated using TypeDoc