com.atlassian.confluence.pages.templates
Class PluginTemplateReference

java.lang.Object
  extended by com.atlassian.confluence.pages.templates.PluginTemplateReference

public class PluginTemplateReference
extends Object

Used to reference a template based on the complete module key, space and referencing plugin key

Since:
v5.1

Method Summary
 boolean equals(Object obj)
           
 com.atlassian.plugin.ModuleCompleteKey getModuleCompleteKey()
           
 com.atlassian.plugin.ModuleCompleteKey getReferencingModuleCompleteKey()
           
 Space getSpace()
           
static PluginTemplateReference globalTemplateReference(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey, com.atlassian.plugin.ModuleCompleteKey referencingModuleCompleteKey)
          Create a reference to the globally customised version of the template
 int hashCode()
           
static PluginTemplateReference spaceTemplateReference(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey, com.atlassian.plugin.ModuleCompleteKey referencingModuleCompleteKey, Space space)
          Create a reference to the space level customised version of the template
static PluginTemplateReference systemTemplateReference(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)
          Create a reference to the globally customised version of a system template
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

spaceTemplateReference

public static PluginTemplateReference spaceTemplateReference(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey,
                                                             com.atlassian.plugin.ModuleCompleteKey referencingModuleCompleteKey,
                                                             Space space)
Create a reference to the space level customised version of the template

Parameters:
moduleCompleteKey - The complete module key of the template
referencingModuleCompleteKey - The complete module key of the blueprint that is referencing this template
space - The space in which the template is being referenced (can be null)

globalTemplateReference

public static PluginTemplateReference globalTemplateReference(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey,
                                                              com.atlassian.plugin.ModuleCompleteKey referencingModuleCompleteKey)
Create a reference to the globally customised version of the template

Parameters:
moduleCompleteKey - The complete module key of the template
referencingModuleCompleteKey - The complete module key of the blueprint that is referencing this template

systemTemplateReference

public static PluginTemplateReference systemTemplateReference(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)
Create a reference to the globally customised version of a system template

Parameters:
moduleCompleteKey - The complete module key of the system template

getModuleCompleteKey

public com.atlassian.plugin.ModuleCompleteKey getModuleCompleteKey()

getReferencingModuleCompleteKey

public com.atlassian.plugin.ModuleCompleteKey getReferencingModuleCompleteKey()

getSpace

public Space getSpace()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2003–2015 Atlassian. All rights reserved.