Interface IRuntimeReferenceLookup

Method Details

• getRuntimePropFromReference

  default GProp<?> getRuntimePropFromReference(String reference)

  Gets a reference for runtime use to get the reference of an item. The reference must be fully qualified such as "*ALIAS:/type/path" or "MODULE:/type/path" and cannot be relative.

  Note: The reference can be to the static or virtualized properties, but if a property type is virtualized and the property is not found, a fall-back to search the application for the static non-virtualized property IS NOT PERFORMED.

  Calling this method is the same as calling getRuntimePropFromReference(reference, false)}.

  Parameters:

  reference - The reference to look-up.

  Returns:

  The property found, or null for reference not found.

• getRuntimePropFromReference

  GProp<?> getRuntimePropFromReference(String reference, boolean fallBackToNonVirtualized)

  Gets a reference for runtime use to get the reference of an item. The reference must be fully qualified such as "*ALIAS:/type/path" or "MODULE:/type/path" and cannot be relative.

  If the flag fallBackToNonVirtualized is false, the search will not fallback to searching for the non-virtualized property in the runtime app. The result will only returned virtualized properties, i.e. for a reference as e.g. "module:/vs/someVS", and depending on where this method is called (the client session), also includes other virtualized properties such as panels as e.g. "module:/panel/somePanel".

  To always fallback to also searching the runtime app, specify fallBackToNonVirtualized to true.

  Parameters:

  reference - The reference to look-up.

  fallBackToNonVirtualized - Flag indicating a fallback to non-virtualized properties.

  Returns:

  The property found, or null for reference not found.

• getRootFromName

  PropCnr getRootFromName(GProp<?> requestor, String module)

  Gets the module root for a name. In the Editor, the module is the project, and that root container is returned. In the Server, the module doesn't matter, so the real root returns itself.

  When running with assertions, this call throws an assertion error by default, showing that the call is directed to a non-root property container.

  Parameters:

  requestor - The requestor property.

  module - The module name (without colon), i.e. the project name in the Designer.

  Returns:

  The root property container, or null if this container is not the root, or if the module name is not found. The default implementation returns null.

• getEnvironment

  EnvProps getEnvironment()

  Gets the environment properties to use.

  Returns:

  The environment for the client session, original session or server in that priority order.

• getAppFactory

  AppFactory getAppFactory()

  Gets the application factory.

  Returns:

  The AppFactory.