Skip to content

OrgShape

pozil edited this page Oct 11, 2021 · 14 revisions

layout: default

OrgShape class

Class contains static methods for determining if specific platform features are enabled. For example, do we have platform cache enabled. You could also write similar methods for experiences.


Properties

getFiscalYearStartMonthInteger

returns this org's fiscal year starting month

hasNamespacePrefixBoolean

reports whether this transaction took place in an org with a namespace prefix

idId

reports the org's ID. in practice, this is a constant

instanceNameString

returns the instance name. In practice not null.

isReadOnlyBoolean

reports the read-only status. this is a proxy for 'is this org active'

isSandboxBoolean

property reports whether this transaction took place in a sandbox.

lightningEnabledBoolean

reports the users' displayed theme.

localeString

reports the org's locale

multiCurrencyEnabledBoolean

reports whether or not this transaction took place in an org with multiCurrency enabled. Note: I have no idea why the underlying method is on UserInfo.

nameString

reports the org's name

namespacePrefixString

reports the namespace prefix of this org. May return null;

orgShapeOrganization

orgTypeString

reports this org's type. ie: 'Developer Edition'

podNameString

convenience method. Alias for instanceName

safeDefaultCachePartitionCache.OrgPartition

timeZoneKeyString

reports the timeZoneSidKey


Methods

getAvailableOrgCachePartition()Cache.OrgPartition

This method is responsible for discovering a cache partition that can be used for determining if platformCache is enabled and configured. Note: This method memoizes the result of the query, ensuring that the underlying soql query is only ever run once per transaction.

Return

Type

Cache.OrgPartition

Description

String

getOrgRecord()Organization

Private method for pulling the Organization record Note: We're suppressing PMD warning on Crud Checking because we want everyone to be able to pull this read-only record.

getOrgShape()Organization

Private method that memoizes the query result Suppressing the PMD warning to validate crud permissions before DML, because the Organization Object is always available.

Return

Type

Organization

Description

Organization

isAdvancedMultiCurrencyManagementEnabled()Boolean

Uses a dynamic soql query to determine if Advanced MultiCurrency Management is enabled. Note, this must be a dynamic soql query because referencing DatedConversionRate will not compile in orgs without Advanced MultiCurrency Management enabled. Note: This was originally written by the NPSP team and can be found here: https://github.com/SalesforceFoundation/NPSP/blob/aad20ffb747ecda9a037c4bce9cd19617b6a727b/src/classes/UTIL_Currency.cls#L79

Return

Type

Boolean

Description

Boolean

isPlatformCacheEnabled()Boolean

Method determines if platform cache is enabled for this org Note: fail-safes to false. Note: Allows override by setting OrgShape.disablePlatformCache equal to true. Use this in test contexts where cache is not available like when you have to use seeAllData=true

Return

Type

Boolean

Description

Boolean

isSeeAllDataTrue()Boolean

Certain features of the platform are incompatible with data-siloed tests. These features require testing with the annotation @test(seeAllData=true). Other platform features are incompatible with seeAllData=true. When used in a test context, this method determines if the currently running test is executing with, or without seeAllData=true. This method is therefore used to automatically disable platform features that require are incompatible with seeAllData=true. For example: platform cache is incompatible with seeAllData=true. However, our security library, CanTheUser utilizes platform cache to accelerate Crud and FLS checks. CanTheUser uses this method, in part, to determine, transparently if it should utilize platformCache during test execution Note: It is not a good idea, and against best practices to use seeAllData=true when not absolutely necessary.

Return

Type

Boolean

Description

Boolean


Inner Classes

OrgShape.CachedOrgShape class


Methods

doLoad(String requiredButNotUsed)Organization

Note: We're suppressing PMD warning on Crud Checking because we want everyone to be able to pull this read-only record.


Clone this wiki locally