Portal (force-metadata-api 40.0.0 API)

java.lang.Object
- com.sforce.soap.metadata.Metadata
- - com.sforce.soap.metadata.Portal

All Implemented Interfaces:

XMLizable
```
public class Portal
extends Metadata
```
This is a generated class for the SObject Enterprise API. Do not edit this file, as your changes will be lost.

Constructor Summary

Constructors
Constructor and Description

Portal()
Constructor

Constructors
Constructor and Description
`Portal()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getActive()`
`String`	`getAdmin()`
`String`	`getDefaultLanguage()`
`String`	`getDescription()`
`String`	`getEmailSenderAddress()`
`String`	`getEmailSenderName()`
`boolean`	`getEnableSelfCloseCase()`
`String`	`getFooterDocument()`
`String`	`getForgotPassTemplate()`
`String`	`getHeaderDocument()`
`boolean`	`getIsSelfRegistrationActivated()`
`String`	`getLoginHeaderDocument()`
`String`	`getLogoDocument()`
`String`	`getLogoutUrl()`
`String`	`getNewCommentTemplate()`
`String`	`getNewPassTemplate()`
`String`	`getNewUserTemplate()`
`String`	`getOwnerNotifyTemplate()`
`String`	`getSelfRegNewUserUrl()`
`String`	`getSelfRegUserDefaultProfile()`
`PortalRoles`	`getSelfRegUserDefaultRole()`
`String`	`getSelfRegUserTemplate()`
`boolean`	`getShowActionConfirmation()`
`String`	`getStylesheetDocument()`
`PortalType`	`getType()`
`boolean`	`isActive()`
`boolean`	`isEnableSelfCloseCase()`
`boolean`	`isIsSelfRegistrationActivated()`
`boolean`	`isShowActionConfirmation()`
`void`	`load(XmlInputStream __in, TypeMapper __typeMapper)`
`protected void`	`loadFields(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setActive(boolean active)`
`protected void`	`setActive(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setAdmin(String admin)`
`protected void`	`setAdmin(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDefaultLanguage(String defaultLanguage)`
`protected void`	`setDefaultLanguage(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDescription(String description)`
`protected void`	`setDescription(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setEmailSenderAddress(String emailSenderAddress)`
`protected void`	`setEmailSenderAddress(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setEmailSenderName(String emailSenderName)`
`protected void`	`setEmailSenderName(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setEnableSelfCloseCase(boolean enableSelfCloseCase)`
`protected void`	`setEnableSelfCloseCase(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFooterDocument(String footerDocument)`
`protected void`	`setFooterDocument(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setForgotPassTemplate(String forgotPassTemplate)`
`protected void`	`setForgotPassTemplate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setHeaderDocument(String headerDocument)`
`protected void`	`setHeaderDocument(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setIsSelfRegistrationActivated(boolean isSelfRegistrationActivated)`
`protected void`	`setIsSelfRegistrationActivated(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setLoginHeaderDocument(String loginHeaderDocument)`
`protected void`	`setLoginHeaderDocument(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setLogoDocument(String logoDocument)`
`protected void`	`setLogoDocument(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setLogoutUrl(String logoutUrl)`
`protected void`	`setLogoutUrl(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setNewCommentTemplate(String newCommentTemplate)`
`protected void`	`setNewCommentTemplate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setNewPassTemplate(String newPassTemplate)`
`protected void`	`setNewPassTemplate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setNewUserTemplate(String newUserTemplate)`
`protected void`	`setNewUserTemplate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setOwnerNotifyTemplate(String ownerNotifyTemplate)`
`protected void`	`setOwnerNotifyTemplate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSelfRegNewUserUrl(String selfRegNewUserUrl)`
`protected void`	`setSelfRegNewUserUrl(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSelfRegUserDefaultProfile(String selfRegUserDefaultProfile)`
`protected void`	`setSelfRegUserDefaultProfile(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSelfRegUserDefaultRole(PortalRoles selfRegUserDefaultRole)`
`protected void`	`setSelfRegUserDefaultRole(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSelfRegUserTemplate(String selfRegUserTemplate)`
`protected void`	`setSelfRegUserTemplate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setShowActionConfirmation(boolean showActionConfirmation)`
`protected void`	`setShowActionConfirmation(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setStylesheetDocument(String stylesheetDocument)`
`protected void`	`setStylesheetDocument(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setType(PortalType type)`
`protected void`	`setType(XmlInputStream __in, TypeMapper __typeMapper)`
`String`	`toString()`
`void`	`write(QName __element, XmlOutputStream __out, TypeMapper __typeMapper)`
`protected void`	`writeFields(XmlOutputStream __out, TypeMapper __typeMapper)`

Methods inherited from class com.sforce.soap.metadata.Metadata
getFullName, setFullName, setFullName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- Portal
```
public Portal()
```
  Constructor

Method Detail

getActive
```
public boolean getActive()
```

isActive
```
public boolean isActive()
```

setActive

public void setActive(boolean active)

setActive

protected void setActive(XmlInputStream __in,
                         TypeMapper __typeMapper)
                  throws IOException,
                         ConnectionException

Throws:: IOException; ConnectionException

getAdmin
```
public String getAdmin()
```

setAdmin
```
public void setAdmin(String admin)
```

setAdmin

protected void setAdmin(XmlInputStream __in,
                        TypeMapper __typeMapper)
                 throws IOException,
                        ConnectionException

Throws:: IOException; ConnectionException

getDefaultLanguage
```
public String getDefaultLanguage()
```

setDefaultLanguage

public void setDefaultLanguage(String defaultLanguage)

setDefaultLanguage

protected void setDefaultLanguage(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

setDescription

protected void setDescription(XmlInputStream __in,
                              TypeMapper __typeMapper)
                       throws IOException,
                              ConnectionException

Throws:: IOException; ConnectionException

getEmailSenderAddress
```
public String getEmailSenderAddress()
```

setEmailSenderAddress

public void setEmailSenderAddress(String emailSenderAddress)

setEmailSenderAddress

protected void setEmailSenderAddress(XmlInputStream __in,
                                     TypeMapper __typeMapper)
                              throws IOException,
                                     ConnectionException

Throws:: IOException; ConnectionException

getEmailSenderName
```
public String getEmailSenderName()
```

setEmailSenderName

public void setEmailSenderName(String emailSenderName)

setEmailSenderName

protected void setEmailSenderName(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getEnableSelfCloseCase

public boolean getEnableSelfCloseCase()

isEnableSelfCloseCase

public boolean isEnableSelfCloseCase()

setEnableSelfCloseCase

public void setEnableSelfCloseCase(boolean enableSelfCloseCase)

setEnableSelfCloseCase

protected void setEnableSelfCloseCase(XmlInputStream __in,
                                      TypeMapper __typeMapper)
                               throws IOException,
                                      ConnectionException

Throws:: IOException; ConnectionException

getFooterDocument
```
public String getFooterDocument()
```

setFooterDocument

public void setFooterDocument(String footerDocument)

setFooterDocument

protected void setFooterDocument(XmlInputStream __in,
                                 TypeMapper __typeMapper)
                          throws IOException,
                                 ConnectionException

Throws:: IOException; ConnectionException

getForgotPassTemplate
```
public String getForgotPassTemplate()
```

setForgotPassTemplate

public void setForgotPassTemplate(String forgotPassTemplate)

setForgotPassTemplate

protected void setForgotPassTemplate(XmlInputStream __in,
                                     TypeMapper __typeMapper)
                              throws IOException,
                                     ConnectionException

Throws:: IOException; ConnectionException

getHeaderDocument
```
public String getHeaderDocument()
```

setHeaderDocument

public void setHeaderDocument(String headerDocument)

setHeaderDocument

protected void setHeaderDocument(XmlInputStream __in,
                                 TypeMapper __typeMapper)
                          throws IOException,
                                 ConnectionException

Throws:: IOException; ConnectionException

getIsSelfRegistrationActivated

public boolean getIsSelfRegistrationActivated()

isIsSelfRegistrationActivated

public boolean isIsSelfRegistrationActivated()

setIsSelfRegistrationActivated

public void setIsSelfRegistrationActivated(boolean isSelfRegistrationActivated)

setIsSelfRegistrationActivated

protected void setIsSelfRegistrationActivated(XmlInputStream __in,
                                              TypeMapper __typeMapper)
                                       throws IOException,
                                              ConnectionException

Throws:: IOException; ConnectionException

getLoginHeaderDocument

public String getLoginHeaderDocument()

setLoginHeaderDocument

public void setLoginHeaderDocument(String loginHeaderDocument)

setLoginHeaderDocument

protected void setLoginHeaderDocument(XmlInputStream __in,
                                      TypeMapper __typeMapper)
                               throws IOException,
                                      ConnectionException

Throws:: IOException; ConnectionException

getLogoDocument
```
public String getLogoDocument()
```

setLogoDocument

public void setLogoDocument(String logoDocument)

setLogoDocument

protected void setLogoDocument(XmlInputStream __in,
                               TypeMapper __typeMapper)
                        throws IOException,
                               ConnectionException

Throws:: IOException; ConnectionException

getLogoutUrl
```
public String getLogoutUrl()
```

setLogoutUrl

public void setLogoutUrl(String logoutUrl)

setLogoutUrl

protected void setLogoutUrl(XmlInputStream __in,
                            TypeMapper __typeMapper)
                     throws IOException,
                            ConnectionException

Throws:: IOException; ConnectionException

getNewCommentTemplate
```
public String getNewCommentTemplate()
```

setNewCommentTemplate

public void setNewCommentTemplate(String newCommentTemplate)

setNewCommentTemplate

protected void setNewCommentTemplate(XmlInputStream __in,
                                     TypeMapper __typeMapper)
                              throws IOException,
                                     ConnectionException

Throws:: IOException; ConnectionException

getNewPassTemplate
```
public String getNewPassTemplate()
```

setNewPassTemplate

public void setNewPassTemplate(String newPassTemplate)

setNewPassTemplate

protected void setNewPassTemplate(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getNewUserTemplate
```
public String getNewUserTemplate()
```

setNewUserTemplate

public void setNewUserTemplate(String newUserTemplate)

setNewUserTemplate

protected void setNewUserTemplate(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getOwnerNotifyTemplate

public String getOwnerNotifyTemplate()

setOwnerNotifyTemplate

public void setOwnerNotifyTemplate(String ownerNotifyTemplate)

setOwnerNotifyTemplate

protected void setOwnerNotifyTemplate(XmlInputStream __in,
                                      TypeMapper __typeMapper)
                               throws IOException,
                                      ConnectionException

Throws:: IOException; ConnectionException

getSelfRegNewUserUrl
```
public String getSelfRegNewUserUrl()
```

setSelfRegNewUserUrl

public void setSelfRegNewUserUrl(String selfRegNewUserUrl)

setSelfRegNewUserUrl

protected void setSelfRegNewUserUrl(XmlInputStream __in,
                                    TypeMapper __typeMapper)
                             throws IOException,
                                    ConnectionException

Throws:: IOException; ConnectionException

getSelfRegUserDefaultProfile

public String getSelfRegUserDefaultProfile()

setSelfRegUserDefaultProfile

public void setSelfRegUserDefaultProfile(String selfRegUserDefaultProfile)

setSelfRegUserDefaultProfile

protected void setSelfRegUserDefaultProfile(XmlInputStream __in,
                                            TypeMapper __typeMapper)
                                     throws IOException,
                                            ConnectionException

Throws:: IOException; ConnectionException

getSelfRegUserDefaultRole

public PortalRoles getSelfRegUserDefaultRole()

setSelfRegUserDefaultRole

public void setSelfRegUserDefaultRole(PortalRoles selfRegUserDefaultRole)

setSelfRegUserDefaultRole

protected void setSelfRegUserDefaultRole(XmlInputStream __in,
                                         TypeMapper __typeMapper)
                                  throws IOException,
                                         ConnectionException

Throws:: IOException; ConnectionException

getSelfRegUserTemplate

public String getSelfRegUserTemplate()

setSelfRegUserTemplate

public void setSelfRegUserTemplate(String selfRegUserTemplate)

setSelfRegUserTemplate

protected void setSelfRegUserTemplate(XmlInputStream __in,
                                      TypeMapper __typeMapper)
                               throws IOException,
                                      ConnectionException

Throws:: IOException; ConnectionException

getShowActionConfirmation

public boolean getShowActionConfirmation()

isShowActionConfirmation

public boolean isShowActionConfirmation()

setShowActionConfirmation

public void setShowActionConfirmation(boolean showActionConfirmation)

setShowActionConfirmation

protected void setShowActionConfirmation(XmlInputStream __in,
                                         TypeMapper __typeMapper)
                                  throws IOException,
                                         ConnectionException

Throws:: IOException; ConnectionException

getStylesheetDocument
```
public String getStylesheetDocument()
```

setStylesheetDocument

public void setStylesheetDocument(String stylesheetDocument)

setStylesheetDocument

protected void setStylesheetDocument(XmlInputStream __in,
                                     TypeMapper __typeMapper)
                              throws IOException,
                                     ConnectionException

Throws:: IOException; ConnectionException

getType
```
public PortalType getType()
```

setType
```
public void setType(PortalType type)
```

setType

protected void setType(XmlInputStream __in,
                       TypeMapper __typeMapper)
                throws IOException,
                       ConnectionException

Throws:: IOException; ConnectionException

write

public void write(QName __element,
                  XmlOutputStream __out,
                  TypeMapper __typeMapper)
           throws IOException

Specified by:: write in interface XMLizable
Overrides:: write in class Metadata
Throws:: IOException

writeFields

protected void writeFields(XmlOutputStream __out,
                           TypeMapper __typeMapper)
                    throws IOException

Overrides:: writeFields in class Metadata
Throws:: IOException

load

public void load(XmlInputStream __in,
                 TypeMapper __typeMapper)
          throws IOException,
                 ConnectionException

Specified by:: load in interface XMLizable
Overrides:: load in class Metadata
Throws:: IOException; ConnectionException

loadFields

protected void loadFields(XmlInputStream __in,
                          TypeMapper __typeMapper)
                   throws IOException,
                          ConnectionException

Overrides:: loadFields in class Metadata
Throws:: IOException; ConnectionException

toString
```
public String toString()
```
Overrides:

toString in class Metadata

Class Portal

Constructor Summary

Method Summary

Methods inherited from class com.sforce.soap.metadata.Metadata

Methods inherited from class java.lang.Object

Constructor Detail

Portal

Method Detail

getActive

isActive

setActive

setActive

getAdmin

setAdmin

setAdmin

getDefaultLanguage

setDefaultLanguage

setDefaultLanguage

getDescription

setDescription

setDescription

getEmailSenderAddress

setEmailSenderAddress

setEmailSenderAddress

getEmailSenderName

setEmailSenderName

setEmailSenderName

getEnableSelfCloseCase

isEnableSelfCloseCase

setEnableSelfCloseCase

setEnableSelfCloseCase

getFooterDocument

setFooterDocument

setFooterDocument

getForgotPassTemplate

setForgotPassTemplate

setForgotPassTemplate

getHeaderDocument

setHeaderDocument

setHeaderDocument

getIsSelfRegistrationActivated

isIsSelfRegistrationActivated

setIsSelfRegistrationActivated

setIsSelfRegistrationActivated

getLoginHeaderDocument

setLoginHeaderDocument

setLoginHeaderDocument

getLogoDocument

setLogoDocument

setLogoDocument

getLogoutUrl

setLogoutUrl

setLogoutUrl

getNewCommentTemplate

setNewCommentTemplate

setNewCommentTemplate

getNewPassTemplate

setNewPassTemplate

setNewPassTemplate

getNewUserTemplate

setNewUserTemplate

setNewUserTemplate

getOwnerNotifyTemplate

setOwnerNotifyTemplate

setOwnerNotifyTemplate

getSelfRegNewUserUrl

setSelfRegNewUserUrl

setSelfRegNewUserUrl

getSelfRegUserDefaultProfile

setSelfRegUserDefaultProfile

setSelfRegUserDefaultProfile

getSelfRegUserDefaultRole

setSelfRegUserDefaultRole

setSelfRegUserDefaultRole

getSelfRegUserTemplate

setSelfRegUserTemplate

setSelfRegUserTemplate

getShowActionConfirmation

isShowActionConfirmation

setShowActionConfirmation